Download OpenAPI specification:Download
The billing service is used to manage payment information.
Updates a billing configuration for an organization
object (BillingAddress) BillingAddress is the definition of a billing address | |
object (OrganizationBillingInformation) OrganizationBillingInformation contains information about an organization's billing | |
object (OrganizationLock) OrganizationLock describes the state of a locked organization | |
organizationName | string Name of the organization, only set on creation to set in on the invoice |
object (PaymentOption) PaymentOption is the definition of a payment option |
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
Creates a billing configuration for an organization
object (BillingAddress) BillingAddress is the definition of a billing address | |
object (OrganizationBillingInformation) OrganizationBillingInformation contains information about an organization's billing | |
object (OrganizationLock) OrganizationLock describes the state of a locked organization | |
organizationName | string Name of the organization, only set on creation to set in on the invoice |
object (PaymentOption) PaymentOption is the definition of a payment option |
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
Get an organizations billing details
organizationID required | integer |
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
Reactivates a terminated organization payment option
organizationID required | integer |
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
Terminates an organization payment option due the next billing
organizationID required | integer |
reason | string reason for terminating our services |
{- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "customerID": 0,
- "email": "string",
- "id": 0,
- "internalOrderID": "string",
- "name": "string",
- "organizationID": 0,
- "phone": "string",
- "postCode": "string",
- "proBono": true,
- "state": "string",
- "surname": "string",
- "vatID": "string"
}, - "organizationBillingInformation": {
- "active": true,
- "owners": [
- 0
], - "terminated": true,
- "terminationDate": null,
- "terminationReason": "string",
- "terminationReceivedDate": null
}, - "organizationLock": {
- "lockDate": null,
- "message": "string",
- "organizationID": 0
}, - "organizationName": "string",
- "paymentOption": {
- "optinDate": null,
- "organizationID": 0,
- "paymentMethod": "string",
- "paymentMethodCreditCard": {
- "ccToken": "string",
- "setupIntentSecret": "string",
- "setupIntentStatus": "string"
}, - "paymentMethodSEPA": {
- "accountHolder": "string",
- "bic": "string",
- "iban": "string"
}
}
}
Get a preview of the organization's current billing cycle
organizationID required | integer |
{- "cycleEnd": null,
- "cycleStart": null,
- "duplicates": 0,
- "inheritingBillingPreviews": [
- { }
], - "items": [
- {
- "amount": 0,
- "creationDate": null,
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0,
- "unitPrice": 0
}
], - "minUserLicenses": 0,
- "organizationID": 0,
- "organizationName": "string",
- "recurringItems": [
- {
- "description": "string",
- "name": "string",
- "organizationID": 0,
- "price": 0,
- "priceAfterBilling": 0,
- "removeAfterBilling": true
}
], - "timestamp": null,
- "total": 0.1,
- "totalRecurring": 0.1,
- "usedUserLicenses": 0,
- "userLicenseUnitPrice": 0
}
Get the current odp-contract of the organization
organizationID required | integer |
{- "activationDetails": {
- "date": null,
- "ipAddress": "string",
- "userEmail": "string",
- "userID": 0,
- "userName": "string",
- "userSurname": "string"
}, - "authorizedPersons": [
- {
- "email": "string",
- "name": "string",
- "phone": "string",
- "surname": "string"
}
], - "client": {
- "address": "string",
- "city": "string",
- "country": "string",
- "emailAddress": "string",
- "organization": "string",
- "postcode": "string"
}, - "contractTemplateID": 0,
- "contractText": "string",
- "isLatestVersion": true,
- "organizationID": 0
}
Updates an existing odp-contract for the given organization
organizationID required | integer |
object (ODPContractActivationDetails) ODPContractActivationDetails contains information about who accepted the odp-contract at which point in time | |
required | Array of objects (ODPContractAuthorizedPerson) |
required | object (ODPContractClient) ODPContractClient contains contact data for an organization creating an odp-contract |
contractTemplateID required | integer <int64> |
organizationID required | integer <int64> |
{- "activationDetails": {
- "date": null,
- "ipAddress": "string",
- "userEmail": "string",
- "userID": 0,
- "userName": "string",
- "userSurname": "string"
}, - "authorizedPersons": [
- {
- "email": "string",
- "name": "string",
- "phone": "string",
- "surname": "string"
}
], - "client": {
- "address": "string",
- "city": "string",
- "country": "string",
- "emailAddress": "string",
- "organization": "string",
- "postcode": "string"
}, - "contractTemplateID": 0,
- "organizationID": 0
}
{- "activationDetails": {
- "date": null,
- "ipAddress": "string",
- "userEmail": "string",
- "userID": 0,
- "userName": "string",
- "userSurname": "string"
}, - "authorizedPersons": [
- {
- "email": "string",
- "name": "string",
- "phone": "string",
- "surname": "string"
}
], - "client": {
- "address": "string",
- "city": "string",
- "country": "string",
- "emailAddress": "string",
- "organization": "string",
- "postcode": "string"
}, - "contractTemplateID": 0,
- "contractText": "string",
- "isLatestVersion": true,
- "organizationID": 0
}
Create an odp-contract using the given details
organizationID required | integer |
object (ODPContractActivationDetails) ODPContractActivationDetails contains information about who accepted the odp-contract at which point in time | |
required | Array of objects (ODPContractAuthorizedPerson) |
required | object (ODPContractClient) ODPContractClient contains contact data for an organization creating an odp-contract |
contractTemplateID required | integer <int64> |
organizationID required | integer <int64> |
{- "activationDetails": {
- "date": null,
- "ipAddress": "string",
- "userEmail": "string",
- "userID": 0,
- "userName": "string",
- "userSurname": "string"
}, - "authorizedPersons": [
- {
- "email": "string",
- "name": "string",
- "phone": "string",
- "surname": "string"
}
], - "client": {
- "address": "string",
- "city": "string",
- "country": "string",
- "emailAddress": "string",
- "organization": "string",
- "postcode": "string"
}, - "contractTemplateID": 0,
- "organizationID": 0
}
{- "activationDetails": {
- "date": null,
- "ipAddress": "string",
- "userEmail": "string",
- "userID": 0,
- "userName": "string",
- "userSurname": "string"
}, - "authorizedPersons": [
- {
- "email": "string",
- "name": "string",
- "phone": "string",
- "surname": "string"
}
], - "client": {
- "address": "string",
- "city": "string",
- "country": "string",
- "emailAddress": "string",
- "organization": "string",
- "postcode": "string"
}, - "contractTemplateID": 0,
- "contractText": "string",
- "isLatestVersion": true,
- "organizationID": 0
}
Get the update between the most recent and the organization's accepted odp-contract template in unified format
organizationID required | integer |
{- "changeSummaries": [
- {
- "date": null,
- "text": "string"
}
], - "unifiedDiff": "string"
}
Get the update between the most recent and odp-contract template and the current odp-contract template in unified format
templateText | string |
{- "templateText": "string"
}
{- "unifiedDiff": "string"
}
Check the status of an organization's pro-bono request
organization_id | integer |
{- "billing_status": true,
- "date_request": null,
- "decision": 0,
- "organization": null,
- "reason": 0,
- "user": null
}
Create a new pro-bono request
billing_status | boolean |
date_request | any |
decision | integer <int64> (ProBonoDecision) ProBonoDecision is our decision on whether the user is granted a discount or not |
organization | any |
reason | integer <int64> (ProBonoReason) ProBonoReason is the user's reason why he beliefs he should be granted a discount |
user | any |
{- "billing_status": true,
- "date_request": null,
- "decision": 0,
- "organization": null,
- "reason": 0,
- "user": null
}