Sign in

v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB
Subscriptions

Subscription - Cancel Subscription

Cancel the subscription

post/subscriptions/{subscription_id}/cancel

Path parameters

subscription_idstring required

The unique identifier for the subscription

Headers

X-Profile-Idstring required

Profile ID for authentication

Request body

cancel_option'immediately' | 'end_of_term' | 'specific_date'
cancel_atstring nullable

Optional date when the subscription should be cancelled (if not provided, cancels immediately)

unbilled_charges_option'invoice' | 'delete'
credit_option_for_current_term_charges'none' | 'prorate' | 'full'
account_receivables_handling'no_action' | 'schedule_payment_collection' | 'write_off'
refundable_credits_handling'no_action' | 'schedule_refund'
cancel_reason_codestring nullable

Reason code for canceling the subscription

Response

Subscription cancelled successfully

idstring required

A type for subscription_id that can be used for subscription ids

status'active' | 'created' | 'in_active' | 'pending' | 'trial' | 'paused' | 'unpaid' | 'onetime' | 'cancelled' | 'failed' required

Possible states of a subscription lifecycle.

  • Created: Subscription was created but not yet activated.
  • Active: Subscription is currently active.
  • InActive: Subscription is inactive.
  • Pending: Subscription is pending activation.
  • Trial: Subscription is in a trial period.
  • Paused: Subscription is paused.
  • Unpaid: Subscription is unpaid.
  • Onetime: Subscription is a one-time payment.
  • Cancelled: Subscription has been cancelled.
  • Failed: Subscription has failed.
merchant_reference_idstring nullable

Merchant specific Unique identifier.

profile_idstring required

A type for profile_id that can be used for business profile ids

merchant_idstring required

A type for merchant_id that can be used for merchant ids

customer_idstring required

A type for customer_id that can be used for customer ids

cancelled_atstring nullable

Date when the subscription was cancelled