Download OpenAPI specification:Download
The billing service implements the billing business logic
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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",
- "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": {
- "nextPaymentMethod": "string",
- "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,
- "totalRecurring": 0,
- "usedUserLicenses": 0,
- "userLicenseUnitPrice": 0
}
Instantaniously switch between an inherited billing from a parent organization or a new / existing whmcs billing account. Organization has to be active already and not terminated. Performing user has to be an owner of the organization and (if applicable) the parent organization. Switching to a new or existing whmcs account requires the organization to be billed through its parent organization. Switching to an inherited billing requires the organization to be billed through its own whmcs account.
object (ExistingCustomerRequest) ExistingCustomerRequest is the definition of a billing request payload | |
object (BillingInheritanceRequest) BillingInheritanceRequest is used to request the inheritance of billing information | |
object (BillingRequest) BillingRequest is the definition of a billing request payload |
{- "existingWHMCSAccount": {
- "email": "string",
- "organizationID": 0,
- "password": "string"
}, - "inheritance": {
- "organizationID": 0,
- "parentOrganizationID": 0
}, - "newWHMCSAccount": {
- "billingAddress": {
- "address1": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "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":