Shift4 Payments · JSON Structure

Shift4 Subscription Structure

The Shift4 Subscription object: a recurring billing instance for a single customer on a single plan.

Type: object Properties: 17
PaymentsFintechCommerceCheckout

Subscription is a JSON Structure definition published by Shift4 Payments, describing 17 properties.

Properties

id created planId customerId quantity captureCharges status remainingBillingCycles start currentPeriodStart currentPeriodEnd canceledAt endedAt trialStart trialEnd cancelAtPeriodEnd metadata

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Subscription",
  "description": "The Shift4 Subscription object: a recurring billing instance for a single customer on a single plan.",
  "type": "object",
  "properties": {
    "id": { "type": "string", "description": "Unique identifier (prefix: sub_)." },
    "created": { "type": "integer", "description": "Unix timestamp (seconds)." },
    "planId": { "type": "string", "description": "ID of the plan driving the subscription." },
    "customerId": { "type": "string", "description": "ID of the subscribed customer." },
    "quantity": { "type": "integer", "description": "Quantity multiplier on the plan amount." },
    "captureCharges": { "type": "boolean", "description": "Whether recurring charges are captured automatically." },
    "status": {
      "type": "string",
      "description": "Lifecycle status.",
      "enum": ["ACTIVE", "PAST_DUE", "CANCELED", "UNPAID"]
    },
    "remainingBillingCycles": { "type": "integer", "description": "Cycles remaining before subscription ends." },
    "start": { "type": "integer", "description": "Unix timestamp the subscription started." },
    "currentPeriodStart": { "type": "integer", "description": "Start of current billing period." },
    "currentPeriodEnd": { "type": "integer", "description": "End of current billing period." },
    "canceledAt": { "type": "integer", "description": "When the subscription was canceled (if applicable)." },
    "endedAt": { "type": "integer", "description": "When the subscription ended (if applicable)." },
    "trialStart": { "type": "integer", "description": "Trial period start, if any." },
    "trialEnd": { "type": "integer", "description": "Trial period end, if any." },
    "cancelAtPeriodEnd": { "type": "boolean", "description": "Whether cancellation is scheduled at period end." },
    "metadata": { "type": "object", "description": "Custom string key-value metadata." }
  }
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/shift4-subscription-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.