Paystack · JSON Structure

Paystack Subscription Structure

JSON Structure for a Paystack recurring subscription.

Type: object Properties: 12 Required: 4
PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

PaystackSubscription is a JSON Structure definition published by Paystack, describing 12 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id subscription_code email_token amount cron_expression next_payment_date status start customer plan authorization created_at

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-structure/paystack-subscription-structure.json",
  "name": "PaystackSubscription",
  "type": "object",
  "description": "JSON Structure for a Paystack recurring subscription.",
  "properties": {
    "id": { "type": "int64" },
    "subscription_code": { "type": "string", "description": "Prefixed with SUB_." },
    "email_token": { "type": "string", "description": "Token for self-service customer management links." },
    "amount": { "type": "int64" },
    "cron_expression": { "type": "string" },
    "next_payment_date": { "type": "string", "format": "date-time" },
    "status": { "type": "string", "description": "active, non-renewing, attention, completed, cancelled." },
    "start": { "type": "int64" },
    "customer": { "type": "object" },
    "plan": { "type": "object" },
    "authorization": { "type": "object" },
    "created_at": { "type": "string", "format": "date-time" }
  },
  "required": ["subscription_code", "customer", "plan", "status"]
}