TWIN APIРуководстваЛичный кабинет
TWIN API

Payment plan list

get
https://billing.twin24.ai/api/v1/paymentPlans

Use this endpoint to view payment plan list.

Query Params
boolean
Defaults to false

Determines whether to return the total number of records.

boolean
Defaults to false

Determines whether to return the record list.

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: companyId, active, service, strategy, interval, intervalCount, createdAt, expiredAt, lastChargedAt, nextChargedAt.

boolean

To select only active or inactive plan items.

integer

To filter by company identifier.

string

Comma-separated payment plan identifiers to filter by.

string
enum

The service to filter by.

Allowed:
string
enum

The payment strategy to filter by.

Allowed:
string
enum

The payment interval to filter by.

Allowed:
integer

The interval count to filter by.

string

The date field to filter by date range.

string

The start date (for example, 2018-05-27T21:30:54+00:00).

string

The end date (for example, 2018-05-27T21:30:54+00:00).

Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Updated 9 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago