API ReferenceChangelog
Log In
API Reference

Retrieve paginated list of Stripe billing periods

get
https://api.pixop.com/api/v2/stripe/billing-periods

Retrieves a paginated list of Stripe billing periods associated with the provided API key.

Query Params
int32
≥ 0
Defaults to 0

Specifies the current page number, starting at 0.

int32
1 to 100
Defaults to 10

Specifies the number of items per page.

string
enum
Defaults to ASC

Specifies the sort direction for the results:

  • ASC: ascending order.
  • DESC: descending order.
Allowed:
string
enum
Defaults to createdAt

Specifies the field to sort the results by.

Allowed:
uuid

Filters results by the specified team ID.

date

Filters results by creation date. Includes only items created at or after the specified date. Defaults to the creation date of the team.
Providing a value greater than the FilterByToDate value results in a 400 Bad Request response.

date

Filters results by creation date. Includes only items created at or before the specified date. Defaults to the current date.
Providing a value smaller than the FilterByFromDate value results in a 400 Bad Request response.

string
enum
Defaults to INCLUDE

Filters results based on the ended mode:

  • INCLUDE: Includes ended billing periods in the result.
  • EXCLUDE: Excludes ended billing periods from the result.
  • ONLY: Only returns ended billing periods in the result.
Allowed:
Responses

Updated 20 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 20 days ago

Did this page help you?