Function SubscriptionsApiFactory

Returns {
    cancelSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    createSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    getSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    listSubscriptions(requestParameters, options?) => AxiosPromise<ListSubscriptions200Response>;
    pauseSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    resumeSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    retrySubscription(requestParameters, options?) => AxiosPromise<Subscription>;
    updateSubscription(requestParameters, options?) => AxiosPromise<Subscription>;
}

• cancelSubscription:function

  • cancelSubscription(requestParameters, options?): AxiosPromise<Subscription>

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

    Summary

    Cancel a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiCancelSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• createSubscription:function

  • createSubscription(requestParameters, options?): AxiosPromise<Subscription>

  • Creates a new Subscription.

    Summary

    Create a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiCreateSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• getSubscription:function

  • getSubscription(requestParameters, options?): AxiosPromise<Subscription>

  • Retrieves the details of an existing Subscription.

    Summary

    Get a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiGetSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• listSubscriptions:function

  • listSubscriptions(requestParameters, options?): AxiosPromise<ListSubscriptions200Response>

  • Returns a list of Subscriptions. The Subscriptions are sorted with the most recently created appearing first.

    Summary

    List all Subscriptions

    Throws

    Parameters

    • requestParameters: SubscriptionsApiListSubscriptionsRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<ListSubscriptions200Response>

• pauseSubscription:function

  • pauseSubscription(requestParameters, options?): AxiosPromise<Subscription>

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

    Summary

    Pause a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiPauseSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• resumeSubscription:function

  • resumeSubscription(requestParameters, options?): AxiosPromise<Subscription>

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

    Summary

    Resume a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiResumeSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• retrySubscription:function

  • retrySubscription(requestParameters, options?): AxiosPromise<Subscription>

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

    Summary

    Retry a Subscription

    Throws

    Parameters

    • requestParameters: SubscriptionsApiRetrySubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>

• updateSubscription:function

  • updateSubscription(requestParameters, options?): AxiosPromise<Subscription>

  • 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

    Parameters

    • requestParameters: SubscriptionsApiUpdateSubscriptionRequest

      Request parameters.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<Subscription>