Vai al contenuto principale
GET
/
api
/
v1
/
organizations
/
{organizationid}
/
stripe
/
subscriptions
List Stripe subscriptions
curl --request GET \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/stripe/subscriptions \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "licenses": [
        {
          "license": {},
          "expires_at": "2023-11-07T05:31:56Z",
          "product": {}
        }
      ],
      "invoices": [
        {
          "billing_reason": "<string>",
          "amount_paid": 123,
          "status_transitions": {},
          "currency": "<string>",
          "status": "<string>",
          "invoice_pdf": "<string>",
          "to_product": "<string>",
          "from_product": "<string>",
          "payment": {
            "requires_action": true,
            "requires_payment_method": true,
            "client_secret": "<string>"
          }
        }
      ],
      "default_payment_method": {
        "brand": "<string>",
        "display_brand": "<string>",
        "last4": "<string>",
        "exp_month": 123,
        "exp_year": 123
      },
      "status": "<string>",
      "current_period_end": 123,
      "cancel_at_period_end": true,
      "created": 123,
      "plan": {
        "currency": "<string>",
        "amount": 123,
        "interval": "<string>"
      }
    }
  ]
}

Autorizzazioni

X-Aegister-Token
string
header
obbligatorio

Parametri del percorso

organizationid
integer
obbligatorio

Organization ID.

Risposta

error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Intervallo richiesto: 0 <= x <= 0
Esempio:

0

messages
array

If error is 1, contains zero or more details on the error.

Esempio:
[]
total
number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Intervallo richiesto: x >= 0
Esempi:

20

30

40

data
object[]