Class SubscriptionAPI

constructor

• new SubscriptionAPI(httpRequest): SubscriptionAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns SubscriptionAPI

Readonly httpRequest

cancelSubscription

• cancelSubscription(): CancelablePromise<SuccessResponse>

• Cancel subscription Cancel the current subscription.

  Returns CancelablePromise<SuccessResponse>

  SuccessResponse

  Throws

  ApiError

createSubscriptionOrder

• createSubscriptionOrder(__namedParameters): CancelablePromise<CreateSubscriptionOrderResponse>

• Create subscription order Create a new subscription order for a plan.

  Parameters

  • __namedParameters: {
        planId: string;
    }

    • planId: string

      ID of the subscription plan

  Returns CancelablePromise<CreateSubscriptionOrderResponse>

  CreateSubscriptionOrderResponse

  Throws

  ApiError

getCurrentSubscription

• getCurrentSubscription(): CancelablePromise<CurrentSubscriptionResponse>

• Get current subscription Get details about the current subscription.

  Returns CancelablePromise<CurrentSubscriptionResponse>

  CurrentSubscriptionResponse

  Throws

  ApiError

listSubscriptionInvoices

• listSubscriptionInvoices(): CancelablePromise<ListSubscriptionInvoicesResponse>

• List subscription invoices Get all invoices for your current subscription.

  Returns CancelablePromise<ListSubscriptionInvoicesResponse>

  ListSubscriptionInvoicesResponse

  Throws

  ApiError

listSubscriptionPlans

• listSubscriptionPlans(): CancelablePromise<ListSubscriptionPlansResponse>

• List subscription plans Get all available subscription plans.

  Returns CancelablePromise<ListSubscriptionPlansResponse>

  ListSubscriptionPlansResponse

  Throws

  ApiError

updateSubscriptionPlan

• updateSubscriptionPlan(__namedParameters): CancelablePromise<CreateSubscriptionOrderResponse>

• Update subscription plan Update the plan for an existing subscription.

  Parameters

  • __namedParameters: {
        planId: string;
        subscriptionId: string;
    }

    • planId: string

      ID of the new plan

    • subscriptionId: string

      ID of the subscription

  Returns CancelablePromise<CreateSubscriptionOrderResponse>

  CreateSubscriptionOrderResponse

  Throws

  ApiError

verifySubscriptionPayment

• verifySubscriptionPayment(__namedParameters): CancelablePromise<SuccessResponse>

• Verify subscription payment Verify a subscription payment using Razorpay signature.

  Parameters

  • __namedParameters: {
        requestBody: VerifySubscriptionPaymentRequest;
    }

    • requestBody: VerifySubscriptionPaymentRequest

  Returns CancelablePromise<SuccessResponse>

  SuccessResponse

  Throws

  ApiError