Stripe Subscriptions module API index

User API

/api/user/subscriptions/active-pricegetawait global.api.user.subscriptions.ActivePrice.get(req)
/api/user/subscriptions/active-productgetawait global.api.user.subscriptions.ActiveProduct.get(req)
/api/user/subscriptions/add-subscription-itempatchawait global.api.user.subscriptions.AddSubscriptionItem.patch(req)
/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/coupongetawait global.api.user.subscriptions.Coupon.get(req)
/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-tax-idpostawait global.api.user.subscriptions.CreateTaxId.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/customers-countgetawait global.api.user.subscriptions.CustomersCount.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-subscription-itempatchawait global.api.user.subscriptions.DeleteSubscriptionItem.patch(req)
/api/user/subscriptions/delete-subscriptiondeleteawait global.api.user.subscriptions.DeleteSubscription.delete(req)
/api/user/subscriptions/delete-tax-iddeleteawait global.api.user.subscriptions.DeleteTaxId.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/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-item-quantitypatchawait global.api.user.subscriptions.SetSubscriptionItemQuantity.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/subscription-itemgetawait global.api.user.subscriptions.SubscriptionItem.get(req)
/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/tax-idgetawait global.api.user.subscriptions.TaxId.get(req)
/api/user/subscriptions/tax-idsgetawait global.api.user.subscriptions.TaxIds.get(req) URL
- all
- limit
- offset
/api/user/subscriptions/tax-rategetawait global.api.user.subscriptions.TaxRate.get(req)
/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/add-subscription-item-tax-ratepatchawait global.api.administrator.subscriptions.AddSubscriptionItemTaxRate.patch(req)
/api/administrator/subscriptions/add-subscription-itempatchawait global.api.administrator.subscriptions.AddSubscriptionItem.patch(req)
/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
- redeem_by
/api/administrator/subscriptions/create-pricepostawait global.api.administrator.subscriptions.CreatePrice.post(req)
POST
- active
- billing_scheme
- currency
- productid
- recurring_aggregate_usage
- recurring_interval
- recurring_interval_count
- recurring_usage_type
- tax_behavior
- tier(1...)_flat_amount
- tier(1...)_unit_amount
- tier(1...)_up_to
- tiers_mode
- transform_quantity_divide_by
- transform_quantity_round
- unit_amount
/api/administrator/subscriptions/create-productpostawait global.api.administrator.subscriptions.CreateProduct.post(req)
POST
- active
- name
- statement_descriptor
- tax_code
- unit_label
/api/administrator/subscriptions/create-refundpostawait global.api.administrator.subscriptions.CreateRefund.post(req)
/api/administrator/subscriptions/create-tax-ratepostawait global.api.administrator.subscriptions.CreateTaxRate.post(req)
POST
- country
- description
- display_name
- inclusive
- jurisdiction
- percentage
- state
- tax_type
/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-pricedeleteawait global.api.administrator.subscriptions.DeletePrice.delete(req)
/api/administrator/subscriptions/delete-productdeleteawait global.api.administrator.subscriptions.DeleteProduct.delete(req)
/api/administrator/subscriptions/delete-subscription-itemdeleteawait global.api.administrator.subscriptions.DeleteSubscriptionItem.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/pricegetawait global.api.administrator.subscriptions.Price.get(req)
/api/administrator/subscriptions/prices-countgetawait global.api.administrator.subscriptions.PricesCount.get(req)
/api/administrator/subscriptions/pricesgetawait global.api.administrator.subscriptions.Prices.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/remove-subscription-item-tax-ratepatchawait global.api.administrator.subscriptions.RemoveSubscriptionItemTaxRate.patch(req)
/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-customer-couponpatchawait global.api.administrator.subscriptions.SetCustomerCoupon.patch(req)
/api/administrator/subscriptions/set-price-activepatchawait global.api.administrator.subscriptions.SetPriceActive.patch(req)
/api/administrator/subscriptions/set-price-inactivepatchawait global.api.administrator.subscriptions.SetPriceInactive.patch(req)
/api/administrator/subscriptions/set-product-activepatchawait global.api.administrator.subscriptions.SetProductActive.patch(req)
/api/administrator/subscriptions/set-product-inactivepatchawait global.api.administrator.subscriptions.SetProductInactive.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/set-subscription-default-tax-ratespatchawait global.api.administrator.subscriptions.SetSubscriptionDefaultTaxRates.patch(req)
/api/administrator/subscriptions/set-subscription-item-quantitypatchawait global.api.administrator.subscriptions.SetSubscriptionItemQuantity.patch(req)
/api/administrator/subscriptions/set-tax-rate-activepatchawait global.api.administrator.subscriptions.SetTaxRateActive.patch(req)
/api/administrator/subscriptions/set-tax-rate-inactivepatchawait global.api.administrator.subscriptions.SetTaxRateInactive.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/subscription-itemgetawait global.api.administrator.subscriptions.SubscriptionItem.get(req)
/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/tax-codegetawait global.api.administrator.subscriptions.TaxCode.get(req)
/api/administrator/subscriptions/tax-codesgetawait global.api.administrator.subscriptions.TaxCodes.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/tax-rategetawait global.api.administrator.subscriptions.TaxRate.get(req)
/api/administrator/subscriptions/tax-rates-countgetawait global.api.administrator.subscriptions.TaxRatesCount.get(req)
/api/administrator/subscriptions/tax-ratesgetawait global.api.administrator.subscriptions.TaxRates.get(req) URL
- all
- limit
- offset
/api/administrator/subscriptions/update-couponpatchawait global.api.administrator.subscriptions.UpdateCoupon.patch(req)
POST
- name
/api/administrator/subscriptions/update-pricepatchawait global.api.administrator.subscriptions.UpdatePrice.patch(req)
POST
- nickname
/api/administrator/subscriptions/update-productpatchawait global.api.administrator.subscriptions.UpdateProduct.patch(req)
POST
- name
- statement_descriptor
- tax_code
- unit_label
/api/administrator/subscriptions/update-tax-ratepatchawait global.api.administrator.subscriptions.UpdateTaxRate.patch(req)
POST
- country
- description
- display_name
- inclusive
- jurisdiction
/api/administrator/subscriptions/usage-recordgetawait global.api.administrator.subscriptions.UsageRecord.get(req)
/api/administrator/subscriptions/usage-records-countgetawait global.api.administrator.subscriptions.UsageRecordsCount.get(req)
/api/administrator/subscriptions/usage-recordsgetawait global.api.administrator.subscriptions.UsageRecords.get(req) URL
- accountid
- all
- customerid
- limit
- offset
- subscriptionid