Resume Subscription Response

Defines output parameters in a response from the ResumeSubscription endpoint.

Structure

ResumeSubscriptionResponse

Fields

Name	Type	Tags	Description	Getter	Setter
`errors`	`?(Error[])`	Optional	Errors encountered during the request.	getErrors(): ?array	setErrors(?array errors): void
`subscription`	`?Subscription`	Optional	Represents a subscription purchased by a customer. For more information, see Manage Subscriptions.	getSubscription(): ?Subscription	setSubscription(?Subscription subscription): void
`actions`	`?(SubscriptionAction[])`	Optional	A list of `RESUME` actions created by the request and scheduled for the subscription.	getActions(): ?array	setActions(?array actions): void

Example (as JSON)

{
  "actions": [
    {
      "effective_date": "2023-09-01",
      "id": "18ff74f4-3da4-30c5-929f-7d6fca84f115",
      "type": "RESUME",
      "monthly_billing_anchor_date": 186,
      "phases": [
        {
          "uid": "uid0",
          "ordinal": 78,
          "order_template_id": "order_template_id2",
          "plan_phase_uid": "plan_phase_uid6"
        },
        {
          "uid": "uid0",
          "ordinal": 78,
          "order_template_id": "order_template_id2",
          "plan_phase_uid": "plan_phase_uid6"
        },
        {
          "uid": "uid0",
          "ordinal": 78,
          "order_template_id": "order_template_id2",
          "plan_phase_uid": "plan_phase_uid6"
        }
      ]
    }
  ],
  "subscription": {
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "created_at": "2023-06-20T21:53:10Z",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
    "location_id": "S8GWD5R9QB376",
    "phases": [
      {
        "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
        "ordinal": 0,
        "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
        "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
      }
    ],
    "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "source": {
      "name": "My Application"
    },
    "start_date": "2023-06-20",
    "status": "ACTIVE",
    "timezone": "America/Los_Angeles",
    "version": 1
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}

2.6 KiB Raw Blame History

Resume Subscription Response

Structure

Fields

Example (as JSON)

2.6 KiB

Raw Blame History