create-subscription-response.md

Create Subscription Response

Defines the fields that are included in the response from the CreateSubscription endpoint.

Structure

CreateSubscriptionResponse

Fields

Name	Type	Tags	Description	Getter	Setter
errors	?(Error[])	Optional	Information about errors encountered during the request.	getErrors(): ?array	setErrors(?array errors): void
subscription	?Subscription	Optional	Represents a customer subscription to a subscription plan. For an overview of the Subscription type, see Subscription object.	getSubscription(): ?Subscription	setSubscription(?Subscription subscription): void

Example (as JSON)

{
  "subscription": {
    "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
    "location_id": "S8GWD5R9QB376",
    "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
    "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
    "start_date": "2020-08-01",
    "status": "PENDING",
    "tax_percentage": "5",
    "price_override_money": {
      "amount": 100,
      "currency": "USD"
    },
    "version": 1594155459464,
    "created_at": "2020-08-03T21:53:10Z",
    "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
    "timezone": "America/Los_Angeles"
  }
}