V2
Contracts
Contract documents associated with subscriptions or bundles
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org | path | string | true | Organization name |
| subscriptionId | path | string(uuid) | true | Subscription unique identifier |
| contractId | path | string(uuid) | true | Contract unique identifier |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contract found | Contract |
| 403 | Forbidden | Forbidden access | ErrorResponse |
| 404 | Not Found | Contract not found | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| default | Default | Any client or server error | ErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org | path | string | true | Organization name |
| subscriptionId | path | string(uuid) | true | Subscription unique identifier |
| offset | query | integer | false | Pagination offset |
| limit | query | integer | false | Pagination limit |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contracts found for the subscription | ContractsSet |
| 403 | Forbidden | Forbidden access | ErrorResponse |
| 404 | Not Found | A subscription with the specified id was not found | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| default | Default | Any client or server error | ErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org | path | string | true | Organization name |
| subscriptionId | path | string(uuid) | true | Subscription unique identifier |
| body | body | Contract | true | Contract data |
Request body - instance of Contract
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string(uuid) | true | Contract id |
| documents_contract_id | string | true | Documents service contract id |
| documents_owner_id | string | true | Documents service owner id |
| creation_date | string(date-time) | false | Creation date according to ISO 8601 |
| creation_user | string | false | User who created the contract |
| creation_system | string | false | System that created the contract |
| last_updated_date | string(date-time) | false | Last update date according to ISO 8601 |
| last_updated_user | string | false | User who last updated the contract |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Contract successfully added | Contract |
| 400 | Bad Request | Bad request | ErrorResponse |
| 403 | Forbidden | Forbidden access | ErrorResponse |
| 404 | Not Found | A subscription with the specified id was not found | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| default | Default | Any client or server error | ErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org | path | string | true | Organization name |
| subscriptionId | path | string(uuid) | true | Subscription unique identifier |
| contractId | path | string(uuid) | true | Contract unique identifier |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contract documents found | ContractDocumentsSet |
| 403 | Forbidden | Forbidden access | ErrorResponse |
| 404 | Not Found | A subscription with the specified id was not found | ErrorResponse |
| 500 | Internal Server Error | Internal server error | ErrorResponse |
| default | Default | Any client or server error | ErrorResponse |
Endpoints
Subscriptions
Bundles
Promotions
Devices
AddOns
Amazon Prime
Max
Mobile
Broadband
Landline
Orange TV
Orange TV Libre
Disney
AgileTv
Netflix
Credit Limits
Change Requests
Commitments
DeviceInsurance
Multisim
Payment Plans
Operations
Contracts