GET
/
v1
/
subscriptions

Authorizations

​
x-pd-api-key
string
headerrequired

Headers

​
x-pd-external-trace-id
string

The external trace ID. The length ranges from 0 to 128 characters.

Query Parameters

​
pageNumber
integer

The number of pages to display. If not specified, the default value 1 will be used.

​
pageSize
integer

The number of items on a single page. If not specified, the default value 10 will be used.

​
targetType
enum<string>

The target type. Possible values are:

  • TEAM_WORKSPACE_CAPACITY: Workspace capacity plans.
  • PROJECT_GENERAL_MODE_PLAN: Plans for jobs that run in general mode.
  • AGENT_MODE_PLAN: Plans for jobs that run in data agent mode.

If not specified, subscriptions of all types will be returned. <Tip> For more information about each type of plans, see Pricing. </Tip>

Available options:
TEAM_WORKSPACE_CAPACITY,
PROJECT_GENERAL_MODE_PLAN,
AGENT_MODE_PLAN
​
status
enum<string>

Subscription status. Possible values are:

  • incomplete_checkout: The payment is pending.
  • active: The subscription is currently active.
  • past_due: The subscription is overdue but within the grace period.
  • fail: Subscription failed.

If not specified, subscriptions of all statuses will be returned.

Multiple statuses can be specified in a comma-separated list, and data sources matching any will be displayed.

Available options:
incomplete_checkout,
active,
past_due,
fail

Response

200 - application/json
​
code
integer
required

Status code. 0 indicates that the operation is successful. Otherwise, the operation fails. Possible error codes include:

  • 100: Bad request.
  • 201: Request frequency limit.
  • 9999: Internal error.
  • 100001: Invalid operation.
​
data
object
required

The returned data object.

UnsubscribeList projects