Skip to content

Subscriptions

Account Scope Required, please include X-Auth-Account header with your Account ID. Scope: billing:read.

List Subscriptions

This currently returns all active or suspended subscriptions.

GET /api/subscriptions

sites is only populated for WordPress hosting

An account's subscriptions cover more than WordPress sites — domains, mail and cPanel hosting each bill on their own subscription. Only a WordPress hosting subscription lists sites; the others return sites: []. Use product to tell them apart.

Sites awaiting deletion are not listed here

The sites array on this page only contains live sites, so pending_delete is always false and delete_scheduled_at is always null on every entry. A site that has been soft-deleted and is awaiting purge drops out of the array altogether. To see soft-deleted sites and their scheduled purge date, use List Sites instead.

Params (optional)
  • page: Integer | page number (default: 1)
  • per_page: Integer | records per page (default: 50, max: 100)
Returned Params
  • subscriptions: Array
    • id: String
    • status: String
    • created_at: DateTime
    • updated_at: DateTime
    • price: Object
      • amount_cents: Integer
      • term: String
    • run_rate: Object | the subscription's recurring charge, serialized as a money object with a cents (Integer) key and a currency_iso (String) key taken from the account's billing plan. It is not a bare integer
    • sites: Array
      • id: String
      • name: String
      • created_at: DateTime
      • updated_at: DateTime
      • primary_domain: String
      • location: String
      • package: String
      • dunning_suspended: Boolean
      • pending_delete: Boolean | always false here — sites awaiting deletion are excluded from sites
      • delete_scheduled_at: DateTime | always null here, for the same reason
    • product: Object
      • id: String
      • name: String

View Subscription

GET /api/subscriptions/:id

Returned Params
  • subscription: Object
    • id: String
    • status: String
    • created_at: DateTime
    • updated_at: DateTime
    • price: Object
      • amount_cents: Integer
      • term: String
    • run_rate: Object | the subscription's recurring charge, serialized as a money object with a cents (Integer) key and a currency_iso (String) key taken from the account's billing plan. It is not a bare integer
    • sites: Array
      • id: String
      • name: String
      • created_at: DateTime
      • updated_at: DateTime
      • primary_domain: String
      • location: String
      • package: String
      • dunning_suspended: Boolean
      • pending_delete: Boolean | always false here — sites awaiting deletion are excluded from sites
      • delete_scheduled_at: DateTime | always null here, for the same reason
    • product: Object
      • id: String
      • name: String