Skip to main content
API docs by Redocly

Divio Cloud API - Billing Resources (v3 (v3))

Download OpenAPI specification:Download

E-mail: info@divio.com URL: https://www.divio.com/ License: BSD License Terms of Service

application-billable-service-plan-prices

ListApplicationBillableServicePlanPrices

List application billable service plan prices

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

GetApplicationBillableServicePlanPrice

Get the details of a single application billable service plan price

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "price": "string"
}

application-billable-service-plans

ListApplicationBillableServicePlans

List application billable service plans

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetApplicationBillableServicePlan

Get the details of a single application billable service plan

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "short_name": "string",
  • "identifier": "string",
  • "active": true,
  • "order": 32767,
  • "price": "string",
  • "service_type": "DOMAINS",
  • "quantity_min": 2147483647,
  • "quantity_max": 2147483647,
  • "quantity_included": 2147483647,
  • "unit": "GB",
  • "unit_multiplier": 0,
  • "marketing_iconname": "string",
  • "marketing_p1_text": "string",
  • "marketing_p2_text": "string",
  • "marketing_calc_text": "string",
  • "marketing_for_text": "string",
  • "marketing_info_text": "string",
  • "marketing_warning_text": "string",
  • "marketing_summary_text": "string",
  • "marketing_summary_total_text": "string"
}

application-plan-groups

ListApplicationPlanGroups

List application plan groups

Authorizations:
Token
query Parameters
organisation
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

GetApplicationPlanGroup

Get the details of a single application plan group

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "id": 0,
  • "name": "string",
  • "short_description_html": "string",
  • "icon": "http://example.com",
  • "identifier": "string",
  • "marketing_identifier": "string",
  • "public": true,
  • "default": true,
  • "can_change_group": true,
  • "order": 32767,
  • "regions": [
    ]
}

application-plan-prices

ListApplicationPlanPrices

List application plan prices

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

GetApplicationPlanPrice

Get the details of a single application plan price

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "price": "string"
}

application-plans

ListApplicationPlans

List application plans

Authorizations:
Token
query Parameters
organisation
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetApplicationPlan

Get the details of a single application plan

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "short_name": "string",
  • "identifier": "string",
  • "public": true,
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "active": true,
  • "visible_to_orgs": [
    ],
  • "is_customisable": true,
  • "services": [
    ],
  • "ram": {
    },
  • "web_instances": {
    },
  • "overrides": "00a06bc9-08a6-4258-aee8-a1a65b9cbb7b",
  • "marketing_instance_text": "string"
}

application-service-subscriptions

ListApplicationServiceSubscriptions

List application service subscriptions

Authorizations:
Token
query Parameters
application
string <uuid>
organisation
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

GetApplicationServiceSubscription

Get the details of a single application service subscription

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "title": "string",
  • "monthly_price": "string",
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "info": "string"
}

application-subscriptions

ListApplicationSubscriptions

List application subscriptions

Authorizations:
Token
query Parameters
application
string <uuid>
organisation
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

CreateApplicationSubscription

Create a new application subscription object

Authorizations:
Token
Request Body schema:
required
plan
required
string <uuid>
ram
required
integer [ 0 .. 2147483647 ]
disk
required
integer [ 0 .. 2147483647 ]
transfer
required
integer [ 0 .. 2147483647 ]
web_instances
required
integer [ 0 .. 2147483647 ]
region
required
string <uuid>
application
required
string <uuid>
required
Array of objects (ApplicationBillableServiceSubscriptionForApplicationSubscription)

Responses

Request samples

Content type
{
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "ram": 2147483647,
  • "disk": 2147483647,
  • "transfer": 2147483647,
  • "web_instances": 2147483647,
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "billable_service_subscriptions": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "monthly_price": "string",
  • "ram": 2147483647,
  • "disk": 2147483647,
  • "transfer": 2147483647,
  • "web_instances": 2147483647,
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "billable_service_subscriptions": [
    ]
}

GetApplicationSubscription

Get the details of a single application subscription

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "monthly_price": "string",
  • "ram": 2147483647,
  • "disk": 2147483647,
  • "transfer": 2147483647,
  • "web_instances": 2147483647,
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "billable_service_subscriptions": [
    ]
}

DestroyApplicationSubscription

Delete the specified application subscription

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

organisation-plans

ListOrganisationPlans

List organisation plans

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

GetOrganisationPlan

Get the details of a single organisation plan

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "identifier": "string",
  • "name": "string",
  • "short_name": "string",
  • "price": "string",
  • "default": true,
  • "order": 32767,
  • "can_change_plan": true,
  • "package": "42c45dbe-c757-4802-9daf-2ba30b05e392",
  • "public": true
}

organisation-subscriptions

ListOrganisationSubscriptions

List organisation subscriptions

Authorizations:
Token
query Parameters
organisation
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetOrganisationSubscription

Get the details of a single organisation subscription

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "created": "2019-08-24T14:15:22Z",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "monthly_price": "string"
}

package-groups

ListPackageGroups

List package groups

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetPackageGroup

Get the details of a single package group

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this package group.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "identifier": "string",
  • "is_addon_package": true,
  • "order": 32767,
  • "features": [
    ]
}

packages

ListPackages

List packages

Authorizations:
Token
query Parameters
group
string <uuid>
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetPackage

Get the details of a single package

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this package.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "identifier": "string",
  • "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
  • "tier": {
    },
  • "description": "string",
  • "options": {
    }
}

payment-methods

ListPaymentMethods

List payment methods

Authorizations:
Token
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

GetPaymentMethod

Get the details of a single payment method

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "billing_email": "user@example.com",
  • "billing_address": "string",
  • "billing_postal_code": "string",
  • "billing_city": "string",
  • "billing_state": "string",
  • "billing_country": "8242b622-2b24-44d1-850f-c6a5e81fa59f",
  • "billing_company": "string",
  • "billing_extra": "string",
  • "billing_is_suspended": true,
  • "billing_suspended_reason": "string",
  • "charge_backend": "CC_STRIPE",
  • "can_change_payment_details": true,
  • "payment_info": "string",
  • "is_sca_activated": true,
  • "sepa_mandate_url": "string",
  • "stripe_payment_method_status": "unknown"
}

UpdatePaymentMethod

Replace the specified payment method

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema:
billing_email
string or null <email> <= 254 characters
billing_address
string (Address)
billing_postal_code
string (Postal code) <= 255 characters
billing_city
string (City) <= 255 characters
billing_state
string (State) <= 255 characters
billing_country
string or null <uuid> (Country)
billing_company
string <= 255 characters
billing_extra
string (Extra Information)

Any information you add here (e.g. VAT ID) will appear on your invoices.

Responses

Request samples

Content type
{
  • "billing_email": "user@example.com",
  • "billing_address": "string",
  • "billing_postal_code": "string",
  • "billing_city": "string",
  • "billing_state": "string",
  • "billing_country": "8242b622-2b24-44d1-850f-c6a5e81fa59f",
  • "billing_company": "string",
  • "billing_extra": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "billing_email": "user@example.com",
  • "billing_address": "string",
  • "billing_postal_code": "string",
  • "billing_city": "string",
  • "billing_state": "string",
  • "billing_country": "8242b622-2b24-44d1-850f-c6a5e81fa59f",
  • "billing_company": "string",
  • "billing_extra": "string"
}

PartialUpdatePaymentMethod

Partially update the specified payment method

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema:
billing_email
string or null <email> <= 254 characters
billing_address
string (Address)
billing_postal_code
string (Postal code) <= 255 characters
billing_city
string (City) <= 255 characters
billing_state
string (State) <= 255 characters
billing_country
string or null <uuid> (Country)
billing_company
string <= 255 characters
billing_extra
string (Extra Information)

Any information you add here (e.g. VAT ID) will appear on your invoices.

Responses

Request samples

Content type
{
  • "billing_email": "user@example.com",
  • "billing_address": "string",
  • "billing_postal_code": "string",
  • "billing_city": "string",
  • "billing_state": "string",
  • "billing_country": "8242b622-2b24-44d1-850f-c6a5e81fa59f",
  • "billing_company": "string",
  • "billing_extra": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "billing_email": "user@example.com",
  • "billing_address": "string",
  • "billing_postal_code": "string",
  • "billing_city": "string",
  • "billing_state": "string",
  • "billing_country": "8242b622-2b24-44d1-850f-c6a5e81fa59f",
  • "billing_company": "string",
  • "billing_extra": "string"
}

RetrievePaymentMethodSetupToken

Only allows reading and updating operations, no create or destroy.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema:
required
stripe_source_id
required
string

Responses

Request samples

Content type
{
  • "stripe_source_id": "string"
}

Response samples

Content type
application/json
{
  • "payment_setup_token": "string"
}

ValidatePaymentMethodToken

Only allows reading and updating operations, no create or destroy.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema:
required
stripe_payment_method_id
required
string

Responses

Request samples

Content type
{
  • "stripe_payment_method_id": "string"
}

Response samples

Content type
application/json
{
  • "stripe_payment_method_id": "string"
}

schema

schema_retrieve

OpenApi3 schema for this API. Format can be selected via content negotiation.

  • YAML: application/vnd.oai.openapi
  • JSON: application/vnd.oai.openapi+json
Authorizations:
TokenNone
query Parameters
format
string
Enum: "json" "yaml"
lang
string
Enum: "af" "ar" "ar-dz" "ast" "az" "be" "bg" "bn" "br" "bs" "ca" "ckb" "cs" "cy" "da" "de" "dsb" "el" "en" "en-au" "en-gb" "eo" "es" "es-ar" "es-co" "es-mx" "es-ni" "es-ve" "et" "eu" "fa" "fi" "fr" "fy" "ga" "gd" "gl" "he" "hi" "hr" "hsb" "hu" "hy" "ia" "id" "ig" "io" "is" "it" "ja" "ka" "kab" "kk" "km" "kn" "ko" "ky" "lb" "lt" "lv" "mk" "ml" "mn" "mr" "ms" "my" "nb" "ne" "nl" "nn" "os" "pa" "pl" "pt" "pt-br" "ro" "ru" "sk" "sl" "sq" "sr" "sr-latn" "sv" "sw" "ta" "te" "tg" "th" "tk" "tr" "tt" "udm" "ug" "uk" "ur" "uz" "vi" "zh-hans" "zh-hant"

Responses

Response samples

Content type
No sample