forked from LiveCarta/PayPal-PHP-Server-SDK
1fc2cf1e07
* Automated commit message * Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
53 lines
1.4 KiB
Markdown
53 lines
1.4 KiB
Markdown
|
|
# Subscription Collection
|
|
|
|
The list of subscriptions.
|
|
|
|
## Structure
|
|
|
|
`SubscriptionCollection`
|
|
|
|
## Fields
|
|
|
|
| Name | Type | Tags | Description | Getter | Setter |
|
|
| --- | --- | --- | --- | --- | --- |
|
|
| `subscriptions` | [`?(Subscription[])`](../../doc/models/subscription.md) | Optional | An array of subscriptions.<br><br>**Constraints**: *Minimum Items*: `0`, *Maximum Items*: `32767` | getSubscriptions(): ?array | setSubscriptions(?array subscriptions): void |
|
|
| `links` | [`?(LinkDescription[])`](../../doc/models/link-description.md) | Optional | An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).<br><br>**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `10` | getLinks(): ?array | setLinks(?array links): void |
|
|
|
|
## Example (as JSON)
|
|
|
|
```json
|
|
{
|
|
"subscriptions": [
|
|
{
|
|
"id": "id6",
|
|
"plan_id": "plan_id8",
|
|
"start_time": "start_time0",
|
|
"quantity": "quantity2",
|
|
"shipping_amount": {
|
|
"currency_code": "currency_code0",
|
|
"value": "value6"
|
|
}
|
|
},
|
|
{
|
|
"id": "id6",
|
|
"plan_id": "plan_id8",
|
|
"start_time": "start_time0",
|
|
"quantity": "quantity2",
|
|
"shipping_amount": {
|
|
"currency_code": "currency_code0",
|
|
"value": "value6"
|
|
}
|
|
}
|
|
],
|
|
"links": [
|
|
{
|
|
"href": "href6",
|
|
"rel": "rel0",
|
|
"method": "HEAD"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|