Subscription API
Version: 4.0.6
API Endpoints
| Request | Summary |
|---|---|
| GET /v1/backoffice/accountStatuses/{id} | Returns the tenant account status, including the evaluation term start/end dates and Service Elections related dates. |
| GET /v1/backoffice/accountStatuses | Returns the account statuses of the Child Tenants. |
| GET /v1/backoffice/products/{serviceType} | Returns a Product. |
| PATCH /v1/backoffice/serviceAgreements/{tenantId} | Approve a tenant service agreement. |
| GET /v1/backoffice/serviceAgreements/{tenantId} | Returns the service agreement details for a tenant. |
| DELETE /v1/backoffice/serviceAgreements/{tenantId} | Reject a tenant service agreement. |
| POST /v1/backoffice/serviceAgreements | Create and submit a service agreement. |
| GET /v1/backoffice/subscriptions | |
| GET /v1/backoffice/tos/{tenantId} | Returns the Terms of Service for the tenant. |
Authorization
OAuth2
For more information about authorization see Getting Started Using the DPoD API.
- Type: OAuth
- Scopes:
- dpod.tenant.spadmin: Service Provider Administrator user role. Used to access the user interface.
- dpod.tenant.admin: Tenant Administrator user role. Used to access the user interface.
- dpod.tenant.appowner: Application Owner user role. Used to access the user interface.
- dpod.tenant.api_spadmin: Service Provider Administrator API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.spadmin permissions to an application.
- dpod.tenant.api_appowner: Tenant Administrator and Application Owner API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.
- dpod.tenant.api_service: Service API role. Used for application authentication over the API, the API role provides a subset of dpod.tenant.appowner and dpod.tenant.admin permissions to an application.