Optional
configuration: ConfigurationProtected
axiosProtected
baseProtected
configurationCancels a Customer's Subscription immediately. The Customer will not be charged again for the Subscription.
Cancel a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Creates a new Subscription.
Create a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Retrieves the details of an existing Subscription.
Get a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Returns a list of Subscriptions. The Subscriptions are sorted with the most recently created appearing first.
List all Subscriptions
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Pauses a Subscription from generating payments until the optionally specified resumes_at
date.
Pause a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Resumes a paused Subscription immediately. The next charge will occur on the regular billing cycle.
Resume a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Retries a subscription payment at the optionally specified next_payment_at
date.
Retry a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Updates an existing Subscription by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
Update a Subscription
SubscriptionsApi
Request parameters.
Optional
options: RawAxiosRequestConfig<any>Override http request option.
Generated using TypeDoc
SubscriptionsApi - object-oriented interface
Export