cancel-subscription-response.md

Cancel Subscription Response

Defines output parameters in a response from the CancelSubscription endpoint.

Structure

CancelSubscriptionResponse

Fields

Name	Type	Tags	Description
errors	Error[] | undefined	Optional	Errors encountered during the request.
subscription	Subscription | undefined	Optional	Represents a subscription to a subscription plan by a subscriber. For an overview of the Subscription type, see Subscription object.
actions	SubscriptionAction[] | undefined	Optional	A list of a single CANCEL action scheduled for the subscription.

Example (as JSON)

{
  "subscription": {
    "canceled_date": "2021-10-20",
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "created_at": "2021-10-20T21:53:10Z",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "id": "910afd30-464a-4e00-a8d8-2296eEXAMPLE",
    "location_id": "S8GWD5R9QB376",
    "paid_until_date": "2021-11-20",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "source": {
      "name": "My App"
    },
    "start_date": "2021-10-20",
    "status": "ACTIVE",
    "timezone": "America/Los_Angeles",
    "version": 1594311617331
  }
}