biterp

List subscription plans

GET
/subscription-plans

Authorization

bearer
AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor from CursorPaginationDto.cursor. Use next_cursor or previous_cursor from the previous response.

limit?integer

Page size from CursorPaginationDto.limit.

Default20
Range1 <= value <= 100
search?string

Full-text search term from CursorPaginationDto.search.

with_deleted?boolean

Include soft-deleted records from CursorPaginationDto.with_deleted.

Defaultfalse
include_payload_search?boolean

Include payload JSON search from CursorPaginationDto.include_payload_search when supported by the endpoint.

Defaultfalse
sort?string

Sort expression from CursorPaginationDto.sort in the format field:order (for example created_at:desc).

name?string

Exact match for "name" (string)

name[neq]?string

Not equal filter for "name" (string)

name[contains]?string

Contains filter for "name"

name[not_contains]?string

Does not contain filter for "name"

reference_code?|

Exact match for "reference_code" (string)

reference_code[neq]?|

Not equal filter for "reference_code" (string)

reference_code[contains]?|

Contains filter for "reference_code"

reference_code[not_contains]?|

Does not contain filter for "reference_code"

reference_code[is_null]?boolean

Filter "reference_code" where the value is null. Pass literal true (for example reference_code[is_null]=true).

Value intrue
reference_code[is_not_null]?boolean

Filter "reference_code" where the value is not null. Pass literal true (for example reference_code[is_not_null]=true).

Value intrue
billing_interval?string

Exact match for "billing_interval" (string)

billing_interval[neq]?string

Not equal filter for "billing_interval" (string)

billing_interval[contains]?string

Contains filter for "billing_interval"

billing_interval[not_contains]?string

Does not contain filter for "billing_interval"

billing_interval_count?number

Exact match for "billing_interval_count" (number)

billing_interval_count[neq]?number

Not equal filter for "billing_interval_count" (number)

billing_interval_count[gt]?number

Greater than filter for "billing_interval_count" (number)

billing_interval_count[gte]?number

Greater than or equal filter for "billing_interval_count" (number)

billing_interval_count[lt]?number

Less than filter for "billing_interval_count" (number)

billing_interval_count[lte]?number

Less than or equal filter for "billing_interval_count" (number)

is_blocked?boolean

Exact match for "is_blocked" (boolean)

is_blocked[neq]?boolean

Not equal filter for "is_blocked" (boolean)

product_id?string

Exact match for "product_id" (string)

product_id[neq]?string

Not equal filter for "product_id" (string)

product_id[contains]?string

Contains filter for "product_id"

product_id[not_contains]?string

Does not contain filter for "product_id"

created_at?string

Exact match for "created_at" (ISO 8601 datetime)

created_at[neq]?string

Not equal filter for "created_at" (ISO 8601 datetime)

created_at[gt]?string

Greater than filter for "created_at" (ISO 8601 datetime)

created_at[gte]?string

Greater than or equal filter for "created_at" (ISO 8601 datetime)

created_at[lt]?string

Less than filter for "created_at" (ISO 8601 datetime)

created_at[lte]?string

Less than or equal filter for "created_at" (ISO 8601 datetime)

updated_at?string

Exact match for "updated_at" (ISO 8601 datetime)

updated_at[neq]?string

Not equal filter for "updated_at" (ISO 8601 datetime)

updated_at[gt]?string

Greater than filter for "updated_at" (ISO 8601 datetime)

updated_at[gte]?string

Greater than or equal filter for "updated_at" (ISO 8601 datetime)

updated_at[lt]?string

Less than filter for "updated_at" (ISO 8601 datetime)

updated_at[lte]?string

Less than or equal filter for "updated_at" (ISO 8601 datetime)

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.biterp.ai/subscription-plans"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
      "reference_code": "string",
      "name": "string",
      "description": "string",
      "billing_interval": "day",
      "billing_interval_count": 0,
      "amount": "string",
      "currency": "string",
      "trial_period_days": 0,
      "is_blocked": true,
      "metadata": {},
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": 0,
    "has_next_page": true,
    "has_previous_page": true,
    "current_query_cursor": "string",
    "current_page_cursor": "string",
    "next_cursor": "string",
    "previous_cursor": "string"
  },
  "meta": {
    "filters": {},
    "search": "string",
    "sort": {
      "field": "string",
      "order": "asc"
    }
  }
}
{
  "status_code": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}
{
  "status_code": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}
{
  "status_code": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}