Account & Billing

Subscription and access state for your shops

Changed on

Your account's billable seats with live Stripe billing state, so a consumer can answer "is this account still entitled to the data I'm reading?" without screen-scraping the portal.

Each seat carries plan, unit_amount (minor units), status, the live stripe_status, current_period_end, trial_end, cancel_at and access_expires_on — the cancel-grace date after which a canceled seat stops granting access.

Only seats linked to shops this key can reach are returned, plus any unassigned seats (which name no shop). Read collection_method and attempt_count before treating past_due as a payment failure: invoice-billed customers sit in past_due legitimately, and attempt_count == 0 means Stripe never attempted a charge.

Read-only — plan changes and cancellation are portal-only.

get/account/subscription

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/account/subscription
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Response

Successful Response

has_stripe_customerboolean required

False when this account has never been billed through Stripe.

Changes

    • info

      api operation id account_subscription_account_subscription_get removed and replaced with account_subscription