forked from LiveCarta/PayPal-PHP-Server-SDK
2.0.0 Release (#58)
* Automated commit message * Automated commit message * add changelog --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
This commit is contained in:
52
doc/models/subscription-collection.md
Normal file
52
doc/models/subscription-collection.md
Normal file
@@ -0,0 +1,52 @@
|
||||
|
||||
# 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"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user