Square · Example Payload

Subscription Example

RestaurantBookingsCatalogCheckoutCustomersDisputesEcommerceFinancial TechnologyGift CardsInventoryInvoicingLaborLocationsLoyaltyMerchantsOrdersPaymentsPoint of SaleRefundsRetailSubscriptionsTeamTerminalWebhooks

Subscription Example is an example object payload from Square, with 19 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idlocation_idplan_variation_idcustomer_idstart_datecanceled_datecharged_through_datestatustax_percentageinvoice_idsprice_override_moneyversioncreated_atcard_idtimezonesourceactionsmonthly_billing_anchor_datephases

Example Payload

{
  "id": "A1B2C3D4E5F6",
  "location_id": "A1B2C3D4E5F6",
  "plan_variation_id": "A1B2C3D4E5F6",
  "customer_id": "A1B2C3D4E5F6",
  "start_date": "2026-03-15",
  "canceled_date": "2026-03-15",
  "charged_through_date": "2026-03-15",
  "status": "ACTIVE",
  "tax_percentage": "sample-value",
  "invoice_ids": [
    "sample-value"
  ],
  "price_override_money": {
    "amount": 26515,
    "currency": "USD"
  },
  "version": 534,
  "created_at": "2026-03-15T14:30:00Z",
  "card_id": "A1B2C3D4E5F6",
  "timezone": "sample-value",
  "source": {
    "name": "Annie\u2019s Hot Sauce"
  },
  "actions": [
    {
      "id": "A1B2C3D4E5F6",
      "type": "CANCEL",
      "effective_date": "2026-03-15"
    }
  ],
  "monthly_billing_anchor_date": 29,
  "phases": [
    {
      "uid": "sample-value",
      "cadence": "EVERY_FOUR_MONTHS",
      "periods": 162,
      "recurring_price_money": {
        "amount": 15941,
        "currency": "USD"
      },
      "ordinal": 67
    },
    {
      "uid": "sample-value",
      "cadence": "SIXTY_DAYS",
      "periods": 985,
      "recurring_price_money": {
        "amount": 21592,
        "currency": "USD"
      },
      "ordinal": 899
    }
  ]
}