GetContractPlanContinuationInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Continuation-token paged input for the plan catalog list. Page forward by passing back the continuation token from the previous page.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
merchantId
required |
string (uuid) | Scope to one merchant's catalog.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
isActive
required |
boolean | Scope to active or inactive plans.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
filter
required |
FilterGroup FilterGroup | The grid's composed chip, search, and summary filters.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
Fields of FilterGroup:
This body has no documented fields. | ||||||||||||||||||
maxResultCount
required |
integer (int32) | Page size.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
continuationToken
required |
string | Continuation token for the next page, as returned by the previous page.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
sorting
required |
SortDescriptor SortDescriptor | Sort field and direction.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
Fields of SortDescriptor: This body has no documented fields. | ||||||||||||||||||
maxCreationTime
required |
string (date-time) | Upper bound on creation time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minCreationTime
required |
string (date-time) | Lower bound on creation time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
maxModificationTime
required |
string (date-time) | Upper bound on last modification time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
maxModifitionTime
required |
string (date-time) | Deprecated misspelled alias of `maxModificationTime`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minModificationTime
required |
string (date-time) | Lower bound on last modification time.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
minModifitionTime
required |
string (date-time) | Deprecated misspelled alias of `minModificationTime`.
nullabledeprecated
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeDeleted
required |
boolean | Include soft-deleted plans, so a deleted plan can be restored from the grid.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeInactive
required |
boolean | Include plans the platform marks inactive.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
includeApproxTotalCount
required |
boolean | Set to false to skip the approximate total count query and receive a null count; omit the
value or set it to true to receive the count as before.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||
This model has no documented fields.