Stripe Subscriptions module API index

User API

/api/user/subscriptions/chargeGETawait global.api.user.subscriptions.Charge.get(req)
/api/user/subscriptions/charges-countGETawait global.api.user.subscriptions.ChargesCount.get(req)
/api/user/subscriptions/chargesGETawait global.api.user.subscriptions.Charges.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/create-cancelation-refundPOSTawait global.api.user.subscriptions.CreateCancelationRefund.post(req)
/api/user/subscriptions/create-customerPOSTawait global.api.user.subscriptions.CreateCustomer.post(req)
/api/user/subscriptions/create-payment-intentPOSTawait global.api.user.subscriptions.CreatePaymentIntent.post(req)
/api/user/subscriptions/create-payment-methodPOSTawait global.api.user.subscriptions.CreatePaymentMethod.post(req)
POST
- cvc
- exp_month
- exp_year
- name
- number
- token
/api/user/subscriptions/create-refund-requestPOSTawait global.api.user.subscriptions.CreateRefundRequest.post(req)
/api/user/subscriptions/create-refundPOSTawait global.api.user.subscriptions.CreateRefund.post(req)
/api/user/subscriptions/create-setup-intentPOSTawait global.api.user.subscriptions.CreateSetupIntent.post(req)
/api/user/subscriptions/create-subscriptionPOSTawait global.api.user.subscriptions.CreateSubscription.post(req)
/api/user/subscriptions/create-usage-recordPOSTawait global.api.user.subscriptions.CreateUsageRecord.post(req)
POST
- action
- quantity
- subscriptionitemid
/api/user/subscriptions/customerGETawait global.api.user.subscriptions.Customer.get(req)
/api/user/subscriptions/customersGETawait global.api.user.subscriptions.Customers.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/delete-customerDELETEawait global.api.user.subscriptions.DeleteCustomer.delete(req)
/api/user/subscriptions/delete-subscriptionDELETEawait global.api.user.subscriptions.DeleteSubscription.delete(req)
/api/user/subscriptions/invoiceGETawait global.api.user.subscriptions.Invoice.get(req)
/api/user/subscriptions/invoices-countGETawait global.api.user.subscriptions.InvoicesCount.get(req)
/api/user/subscriptions/invoicesGETawait global.api.user.subscriptions.Invoices.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/payment-intentGETawait global.api.user.subscriptions.PaymentIntent.get(req)
/api/user/subscriptions/payment-intents-countGETawait global.api.user.subscriptions.PaymentIntentsCount.get(req)
/api/user/subscriptions/payment-intentsGETawait global.api.user.subscriptions.PaymentIntents.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/payment-methodGETawait global.api.user.subscriptions.PaymentMethod.get(req)
/api/user/subscriptions/payment-methods-countGETawait global.api.user.subscriptions.PaymentMethodsCount.get(req)
/api/user/subscriptions/payment-methodsGETawait global.api.user.subscriptions.PaymentMethods.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/published-planGETawait global.api.user.subscriptions.PublishedPlan.get(req)
/api/user/subscriptions/published-plans-countGETawait global.api.user.subscriptions.PublishedPlansCount.get(req)
/api/user/subscriptions/published-plansGETawait global.api.user.subscriptions.PublishedPlans.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/published-productGETawait global.api.user.subscriptions.PublishedProduct.get(req)
/api/user/subscriptions/published-products-countGETawait global.api.user.subscriptions.PublishedProductsCount.get(req)
/api/user/subscriptions/published-productsGETawait global.api.user.subscriptions.PublishedProducts.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/refundGETawait global.api.user.subscriptions.Refund.get(req)
/api/user/subscriptions/refunds-countGETawait global.api.user.subscriptions.RefundsCount.get(req)
/api/user/subscriptions/refundsGETawait global.api.user.subscriptions.Refunds.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/reset-subscription-cancelingPATCHawait global.api.user.subscriptions.ResetSubscriptionCanceling.patch(req)
/api/user/subscriptions/set-customer-couponPATCHawait global.api.user.subscriptions.SetCustomerCoupon.patch(req)
/api/user/subscriptions/set-invoice-paidPATCHawait global.api.user.subscriptions.SetInvoicePaid.patch(req)
/api/user/subscriptions/set-payment-intent-canceledPATCHawait global.api.user.subscriptions.SetPaymentIntentCanceled.patch(req)
/api/user/subscriptions/set-payment-method-detachedPATCHawait global.api.user.subscriptions.SetPaymentMethodDetached.patch(req)
/api/user/subscriptions/set-setup-intent-canceledPATCHawait global.api.user.subscriptions.SetSetupIntentCanceled.patch(req)
/api/user/subscriptions/set-subscription-canceledPATCHawait global.api.user.subscriptions.SetSubscriptionCanceled.patch(req)
/api/user/subscriptions/set-subscription-couponPATCHawait global.api.user.subscriptions.SetSubscriptionCoupon.patch(req)
/api/user/subscriptions/set-subscription-planPATCHawait global.api.user.subscriptions.SetSubscriptionPlan.patch(req)
/api/user/subscriptions/set-subscription-quantityPATCHawait global.api.user.subscriptions.SetSubscriptionQuantity.patch(req)
/api/user/subscriptions/set-subscription-tax-percentPATCHawait global.api.user.subscriptions.SetSubscriptionTaxPercent.patch(req)
/api/user/subscriptions/setup-intentGETawait global.api.user.subscriptions.SetupIntent.get(req)
/api/user/subscriptions/setup-intents-countGETawait global.api.user.subscriptions.SetupIntentsCount.get(req)
/api/user/subscriptions/setup-intentsGETawait global.api.user.subscriptions.SetupIntents.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/subscriptionGETawait global.api.user.subscriptions.Subscription.get(req)
/api/user/subscriptions/subscriptions-countGETawait global.api.user.subscriptions.SubscriptionsCount.get(req)
/api/user/subscriptions/subscriptionsGETawait global.api.user.subscriptions.Subscriptions.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/upcoming-invoiceGETawait global.api.user.subscriptions.UpcomingInvoice.get(req)
/api/user/subscriptions/usage-record-summariesGETawait global.api.user.subscriptions.UsageRecordSummaries.get(req) URL
- ending_before
- limit
- starting_after

Administrator API

/api/administrator/subscriptions/chargeGETawait global.api.administrator.subscriptions.Charge.get(req)
/api/administrator/subscriptions/charges-countGETawait global.api.administrator.subscriptions.ChargesCount.get(req)
/api/administrator/subscriptions/chargesGETawait global.api.administrator.subscriptions.Charges.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/couponGETawait global.api.administrator.subscriptions.Coupon.get(req)
/api/administrator/subscriptions/coupons-countGETawait global.api.administrator.subscriptions.CouponsCount.get(req)
/api/administrator/subscriptions/couponsGETawait global.api.administrator.subscriptions.Coupons.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/create-cancelation-refundPOSTawait global.api.administrator.subscriptions.CreateCancelationRefund.post(req)
/api/administrator/subscriptions/create-couponPOSTawait global.api.administrator.subscriptions.CreateCoupon.post(req)
POST
- amount_off
- currency
- duration
- duration_in_months
- percent_off
/api/administrator/subscriptions/create-planPOSTawait global.api.administrator.subscriptions.CreatePlan.post(req)
POST
- published
- trial_period_days
- usage_type
/api/administrator/subscriptions/create-productPOSTawait global.api.administrator.subscriptions.CreateProduct.post(req)
POST
- published
/api/administrator/subscriptions/create-refundPOSTawait global.api.administrator.subscriptions.CreateRefund.post(req)
/api/administrator/subscriptions/customerGETawait global.api.administrator.subscriptions.Customer.get(req)
/api/administrator/subscriptions/customers-countGETawait global.api.administrator.subscriptions.CustomersCount.get(req)
/api/administrator/subscriptions/customersGETawait global.api.administrator.subscriptions.Customers.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/delete-couponDELETEawait global.api.administrator.subscriptions.DeleteCoupon.delete(req)
/api/administrator/subscriptions/delete-planDELETEawait global.api.administrator.subscriptions.DeletePlan.delete(req)
/api/administrator/subscriptions/delete-productDELETEawait global.api.administrator.subscriptions.DeleteProduct.delete(req)
/api/administrator/subscriptions/delete-subscriptionDELETEawait global.api.administrator.subscriptions.DeleteSubscription.delete(req)
/api/administrator/subscriptions/invoiceGETawait global.api.administrator.subscriptions.Invoice.get(req)
/api/administrator/subscriptions/invoices-countGETawait global.api.administrator.subscriptions.InvoicesCount.get(req)
/api/administrator/subscriptions/invoicesGETawait global.api.administrator.subscriptions.Invoices.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/payment-intentGETawait global.api.administrator.subscriptions.PaymentIntent.get(req)
/api/administrator/subscriptions/payment-intents-countGETawait global.api.administrator.subscriptions.PaymentIntentsCount.get(req)
/api/administrator/subscriptions/payment-intentsGETawait global.api.administrator.subscriptions.PaymentIntents.get(req) URL
- all
- offset
/api/administrator/subscriptions/payment-methodGETawait global.api.administrator.subscriptions.PaymentMethod.get(req)
/api/administrator/subscriptions/payment-methods-countGETawait global.api.administrator.subscriptions.PaymentMethodsCount.get(req)
/api/administrator/subscriptions/payment-methodsGETawait global.api.administrator.subscriptions.PaymentMethods.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/payoutGETawait global.api.administrator.subscriptions.Payout.get(req)
/api/administrator/subscriptions/payouts-countGETawait global.api.administrator.subscriptions.PayoutsCount.get(req)
/api/administrator/subscriptions/payoutsGETawait global.api.administrator.subscriptions.Payouts.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/planGETawait global.api.administrator.subscriptions.Plan.get(req)
/api/administrator/subscriptions/plans-countGETawait global.api.administrator.subscriptions.PlansCount.get(req)
/api/administrator/subscriptions/plansGETawait global.api.administrator.subscriptions.Plans.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/productGETawait global.api.administrator.subscriptions.Product.get(req)
/api/administrator/subscriptions/products-countGETawait global.api.administrator.subscriptions.ProductsCount.get(req)
/api/administrator/subscriptions/productsGETawait global.api.administrator.subscriptions.Products.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/refund-requests-countGETawait global.api.administrator.subscriptions.RefundRequestsCount.get(req)
/api/administrator/subscriptions/refund-requestsGETawait global.api.administrator.subscriptions.RefundRequests.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/refundGETawait global.api.administrator.subscriptions.Refund.get(req)
/api/administrator/subscriptions/refunds-countGETawait global.api.administrator.subscriptions.RefundsCount.get(req)
/api/administrator/subscriptions/refundsGETawait global.api.administrator.subscriptions.Refunds.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/reset-customer-couponPATCHawait global.api.administrator.subscriptions.ResetCustomerCoupon.patch(req) URL
- object
/api/administrator/subscriptions/reset-subscription-couponPATCHawait global.api.administrator.subscriptions.ResetSubscriptionCoupon.patch(req)
/api/administrator/subscriptions/set-charge-flaggedPATCHawait global.api.administrator.subscriptions.SetChargeFlagged.patch(req)
/api/administrator/subscriptions/set-coupon-publishedPATCHawait global.api.administrator.subscriptions.SetCouponPublished.patch(req)
/api/administrator/subscriptions/set-coupon-unpublishedPATCHawait global.api.administrator.subscriptions.SetCouponUnpublished.patch(req)
/api/administrator/subscriptions/set-invoice-uncollectiblePATCHawait global.api.administrator.subscriptions.SetInvoiceUncollectible.patch(req)
/api/administrator/subscriptions/set-plan-publishedPATCHawait global.api.administrator.subscriptions.SetPlanPublished.patch(req)
/api/administrator/subscriptions/set-plan-unpublishedPATCHawait global.api.administrator.subscriptions.SetPlanUnpublished.patch(req)
/api/administrator/subscriptions/set-product-publishedPATCHawait global.api.administrator.subscriptions.SetProductPublished.patch(req)
/api/administrator/subscriptions/set-product-unpublishedPATCHawait global.api.administrator.subscriptions.SetProductUnpublished.patch(req)
/api/administrator/subscriptions/set-refund-request-deniedPATCHawait global.api.administrator.subscriptions.SetRefundRequestDenied.patch(req)
/api/administrator/subscriptions/set-subscription-canceledPATCHawait global.api.administrator.subscriptions.SetSubscriptionCanceled.patch(req)
/api/administrator/subscriptions/set-subscription-couponPATCHawait global.api.administrator.subscriptions.SetSubscriptionCoupon.patch(req)
/api/administrator/subscriptions/setup-intentGETawait global.api.administrator.subscriptions.SetupIntent.get(req)
/api/administrator/subscriptions/setup-intents-countGETawait global.api.administrator.subscriptions.SetupIntentsCount.get(req)
/api/administrator/subscriptions/setup-intentsGETawait global.api.administrator.subscriptions.SetupIntents.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/subscriptionGETawait global.api.administrator.subscriptions.Subscription.get(req)
/api/administrator/subscriptions/subscriptions-countGETawait global.api.administrator.subscriptions.SubscriptionsCount.get(req)
/api/administrator/subscriptions/subscriptionsGETawait global.api.administrator.subscriptions.Subscriptions.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/update-couponPATCHawait global.api.administrator.subscriptions.UpdateCoupon.patch(req)
POST
- name
/api/administrator/subscriptions/update-planPATCHawait global.api.administrator.subscriptions.UpdatePlan.patch(req)
POST
- trial_period_days
/api/administrator/subscriptions/update-productPATCHawait global.api.administrator.subscriptions.UpdateProduct.patch(req)
POST
- name
- statement_descriptor
- unit_label
/api/administrator/subscriptions/usage-record-summariesGETawait global.api.administrator.subscriptions.UsageRecordSummaries.get(req) URL
- ending_before
- limit
- starting_after