List subscriptions - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Query Params

customer

string

optional

The ID of the customer whose subscriptions will be retrieved.

price

string

optional

Filter for subscriptions that contain this recurring price ID.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list.

starting_after

string

optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list.

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/subscriptions?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues'

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {11}]

optional

id

string

optional

object

string

optional

api_version

null

optional

application

null

optional

created

integer

optional

description

string

optional

enabled_events

array[string]

optional

livemode

boolean

optional

metadata

object

optional

status

string

optional

url

string

optional

Example

{
  "object": "\"list\"",
  "url": "string",
  "has_more": true,
  "data": [
    {
      "id": "string",
      "object": "string",
      "api_version": null,
      "application": null,
      "created": 0,
      "description": "string",
      "enabled_events": [
        "string"
      ],
      "livemode": true,
      "metadata": {},
      "status": "string",
      "url": "string"
    }
  ]
}