SEsellauth
Subscriptions

Export Subscriptions

Changed on

Exports the filtered subscriptions as a CSV file.

get/v1/shops/{shopId}/subscriptions/export

Request

Request body

pageinteger nullable

Page number. Must be at least 1.

perPageinteger nullable

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'created_at' | 'current_period_end' | 'recurring_price_usd' | 'cycles_completed' nullable
orderDirection'asc' | 'desc' nullable
idinteger nullable

Filter by subscription ID.

status'pending' | 'trialing' | 'active' | 'past_due' | 'cancelled' | 'expired' nullable

Deprecated. Use statuses.

statusesstring[]
emailstring nullable

Filter by customer email.

customer_idinteger nullable

Filter by customer ID.

product_idinteger nullable

Filter by product ID.

variant_idinteger nullable

Filter by variant ID.

product_namestring nullable

Filter by product name.

variant_namestring nullable

Filter by variant name.

gatewaysobject nullable

Filter by payment gateways.

payment_method_idsobject nullable

Filter by payment method IDs.

intervalsstring[]
renewal_method'auto' | 'manual' nullable

Filter by automatic or manual renewal.

cancel_at_period_endboolean nullable

Only subscriptions set to end at the period end.

has_failed_paymentsboolean nullable

Only subscriptions with failed payments.

suspendedboolean nullable

Only suspended subscriptions.

currencystring nullable

Must be 3 characters.

external_idstring nullable

Filter by the gateway subscription ID.

created_at_startstring nullable

Must be a valid date.

created_at_endstring nullable

Must be a valid date. Must be a date after <code>created_at_start</code>.

current_period_end_startstring nullable

Must be a valid date.

current_period_end_endstring nullable

Must be a valid date. Must be a date after <code>current_period_end_start</code>.

cancelled_at_startstring nullable

Must be a valid date.

cancelled_at_endstring nullable

Must be a valid date. Must be a date after <code>cancelled_at_start</code>.

Example request

{
  "page": 1
}

Changes

  • ff0d59c98d7aRevision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      request property / was restricted to a list of enum values

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the new active enum value to the request property /

    • info

      added the new cancelled enum value to the request property /

    • info

      added the new day enum value to the request property /

    • info

      added the new expired enum value to the request property /

    • info

      added the new month enum value to the request property /

    • info

      added the new past_due enum value to the request property /

    • info

      added the new pending enum value to the request property /

    • info

      added the new trialing enum value to the request property /

    • info

      added the new week enum value to the request property /

    • info

      added the new year enum value to the request property /

  • 5cbdf10d05abRevision changes
    • info

      endpoint added