Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BillingApi

BillingApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • BillingApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • basePath: string = ...
    • axios: AxiosInstance = ...

    Returns BillingApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

billingPost

  • billingPost(request: InlineObject14, options?: any): Promise<AxiosResponse<void>>

  • Update payment method

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    Returns Promise<AxiosResponse<void>>

billingsPlansGet

  • billingsPlansGet(interval?: "all" | "month" | "year", options?: any): Promise<AxiosResponse<PlanGetResponse[]>>

  • Get available plans

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    • Optional interval: "all" | "month" | "year"
    • Optional options: any

    Returns Promise<AxiosResponse<PlanGetResponse[]>>

billingsSubscriptionsGet

  • List all subscriptions in the current shifter account

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    • Optional options: any

    Returns Promise<AxiosResponse<SubscriptionGetResponse[]>>

billingsSubscriptionsPost

billingsSubscriptionsStatusGet

  • billingsSubscriptionsStatusGet(options?: any): Promise<AxiosResponse<object>>

  • Getting subscription status

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    • Optional options: any

    Returns Promise<AxiosResponse<object>>

billingsSubscriptionsSubscriptionIdDelete

  • billingsSubscriptionsSubscriptionIdDelete(subscriptionId: string, options?: any): Promise<AxiosResponse<void>>

  • Delete a subscription

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    • subscriptionId: string
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

billingsSubscriptionsSubscriptionIdPost

  • Update a subscription. Calling this API is allowed to site owner or Administrator members

    throws

    {RequiredError}

    memberof

    BillingApi

    Parameters

    • subscriptionId: string

      Subscription id which update

    • plan: InlineObject13
    • Optional options: any

    Returns Promise<AxiosResponse<SubscriptionUpdateResponse>>

Generated using TypeDoc