swap-plan-response.md

Swap Plan Response

Defines output parameters in a response of the SwapPlan endpoint.

Structure

SwapPlanResponse

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 SWAP_PLAN action created by the request.

Example (as JSON)

{
  "actions": [
    {
      "effective_date": "2021-11-17",
      "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83",
      "new_plan_id": "DPNEOJAP33DKC3GAC5CAZG4O",
      "type": "SWAP_PLAN"
    }
  ],
  "subscription": {
    "created_at": "2021-10-20T21:53:10Z",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "id": "9ba40961-995a-4a3d-8c53-048c40cafc13",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "price_override_money": {
      "amount": 2000,
      "currency": "USD"
    },
    "source": {
      "name": "My App"
    },
    "status": "ACTIVE",
    "timezone": "America/Los_Angeles",
    "version": 1594311617331
  }
}