Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-134807111.3 MB
billing-contract-subscription

Get all subscription billing contract for the authenticated user.

get/user/{userID}/billing-contract-subscription

Path parameters

userIDinteger required

Headers

Cache-Controlstring

The standard HTTP Cache-Control header is required for all signed requests.

User-Agentstring required

The User-Agent header field should contain information about the user agent originating the request. There are no restrictions on the value of this header.

X-Bunq-Languagestring

The X-Bunq-Language header must contain a preferred language indication. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore. Currently only the languages en_US and nl_NL are supported. Anything else will default to en_US.

X-Bunq-Regionstring

The X-Bunq-Region header must contain the region (country) of the client device. The value of this header is formatted as a ISO 639-1 language code plus a ISO 3166-1 alpha-2 country code, separated by an underscore.

X-Bunq-Client-Request-Idstring

This header must specify an ID with each request that is unique for the logged in user. There are no restrictions for the format of this ID. However, the server will respond with an error when the same ID is used again on the same DeviceServer.

X-Bunq-Geolocationstring

This header must specify the geolocation of the device. The format of this value is longitude latitude altitude radius country. The country is expected to be formatted of an ISO 3166-1 alpha-2 country code. When no geolocation is available or known the header must still be included but can be zero valued.

X-Bunq-Client-Authenticationstring required

The authentication token is used to authenticate the source of the API call. It is required by all API calls except for POST /v1/installation. It is important to note that the device and session calls are using the token from the response of the installation call, while all the other calls use the token from the response of the session-server call

Response

Show the subscription billing contract for the authenticated user.

idinteger

The id of the billing contract.

createdstring

The timestamp when the billing contract was made.

updatedstring

The timestamp when the billing contract was last updated.

contract_date_startstring

The date from when the billing contract is valid.

contract_date_endstring

The date until when the billing contract is valid.

contract_versioninteger

The version of the billing contract.

subscription_typestring

The subscription type of the user. Can be one of PERSON_SUPER_LIGHT_V1, PERSON_LIGHT_V1, PERSON_MORE_V1, PERSON_FREE_V1, PERSON_PREMIUM_V1, COMPANY_V1, or COMPANY_V2.

subscription_type_downgradestring

The subscription type the user will have after a subscription downgrade. Will be null if downgrading is not possible.

statusstring

The subscription status.

sub_statusstring

The subscription substatus.