Sign inGet Started

List recurring eSIM subscriptions

GET
/v1/esim/subscriptions
bird esim recurring-subscriptions list
Reactie200
{
  "data": [
    {
      "delivery_mode": "exact_period",
      "id": "ers_01krdgeqcxet5s7t44vh8rt9mg",
      "esim_id": "esm_01krdgeqcxet5s7t44vh8rt9mg",
      "initial_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
      "subscriber_id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
      "offer_id": "eof_01krdgeqcxet5s7t44vh8rt9mg",
      "status": "pending",
      "latest_order_id": "eor_01krdgeqcxet5s7t44vh8rt9mg",
      "price": {
        "amount": "0.00995",
        "currency_code": "USD"
      },
      "model": "calendar_month",
      "stop_reason": "canceled"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns recurring services for assigned eSIMs in this workspace.

Queryparameters

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

subscriber_idstring

Return eSIMs assigned to this subscriber.

esim_idstring

Filter by esim id.

Response Payload

data
array of object
verplicht

Recurring services in this workspace.

Onderliggende attributen tonen
next_cursor
nullable string
verplicht

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
verplicht

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
verplicht

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.