Class SubscriptionsApi

SubscriptionsApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • SubscriptionsApi

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: undefined | Configuration

Methods

  • Cancels a Customer's Subscription immediately. The Customer will not be charged again for the Subscription.

    Summary

    Cancel a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

  • Retrieves the details of an existing Subscription.

    Summary

    Get a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

  • Pauses a Subscription from generating payments until the optionally specified resumes_at date.

    Summary

    Pause a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

  • Resumes a paused Subscription immediately. The next charge will occur on the regular billing cycle.

    Summary

    Resume a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

  • Retries a subscription payment at the optionally specified next_payment_at date.

    Summary

    Retry a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

  • Updates an existing Subscription by setting the values of the provided parameters. Any parameters not provided will be left unchanged.

    Summary

    Update a Subscription

    Throws

    Memberof

    SubscriptionsApi

    Parameters

    Returns Promise<AxiosResponse<Subscription, any>>

Generated using TypeDoc