openapi: 3.2.0 info: title: Configuration Billing Entities API version: 1.0.0 servers: - url: https://test.api.solvimon.com description: The TEST environment for our API - url: https://api.solvimon.com description: The live environment for our API tags: - name: Billing/Entities paths: /v{version}/billing-entities: get: operationId: getBillingEntities summary: Get a list of all billing entities description: Requires the BILLING_ENTITY.VIEW permission. tags: - Billing/Entities parameters: - name: version in: path description: version required: true schema: type: string default: '1' - name: expand[] in: query description: The id fields of the resources that are going to be expanded. required: false schema: type: array items: type: string - name: custom_field in: query description: Filter the response by a custom field value. required: false schema: type: string - name: X-API-KEY in: header required: true schema: type: string - name: x-platform-id in: header description: Platform ID. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingEntityResponseWrapper' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: postBillingEntities summary: Create a billing entity description: Requires the BILLING_ENTITY.CREATE permission. tags: - Billing/Entities parameters: - name: version in: path description: version required: true schema: type: string default: '1' - name: X-API-KEY in: header required: true schema: type: string - name: x-platform-id in: header description: Platform ID. required: false schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BillingEntity' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiError' requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingEntityCreateRequest' put: operationId: putBillingEntities summary: Update or create a billing entity (upsert) description: Requires the BILLING_ENTITY.CREATE or BILLING_ENTITY.UPDATE permission. tags: - Billing/Entities parameters: - name: version in: path description: version required: true schema: type: string default: '1' - name: identifier_field in: query description: Which field to use to identify whether the resource exists or not required: false schema: type: string - name: custom_field_reference in: query description: Which custom field to use to identify whether the resource exists or not required: false schema: type: string - name: field_actions in: query description: The list of actions for specific fields. required: false schema: type: object additionalProperties: type: string - name: X-API-KEY in: header required: true schema: type: string - name: x-platform-id in: header description: Platform ID. required: false schema: type: string responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BillingEntity' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiError' requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingEntityCreateRequest' /v{version}/billing-entities/{resourceIdOrReference}: get: operationId: getBillingEntitiesByResourceIdOrReference summary: Get a billing entity description: Requires the BILLING_ENTITY.VIEW permission. tags: - Billing/Entities parameters: - name: version in: path description: version required: true schema: type: string default: '1' - name: resourceIdOrReference in: path description: The ID or reference of the resource. required: true schema: type: string default: '' - name: X-API-KEY in: header required: true schema: type: string - name: x-platform-id in: header description: Platform ID. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingEntity' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiError' patch: operationId: patchBillingEntitiesByResourceIdOrReference summary: Update a billing entity description: Requires the BILLING_ENTITY.UPDATE permission. tags: - Billing/Entities parameters: - name: version in: path description: version required: true schema: type: string default: '1' - name: resourceIdOrReference in: path description: The ID or reference of the resource. required: true schema: type: string default: '' - name: X-API-KEY in: header required: true schema: type: string - name: x-platform-id in: header description: Platform ID. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BillingEntity' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiError' requestBody: content: application/json: schema: $ref: '#/components/schemas/BillingEntityUpdateRequest' components: schemas: LinkedIntegration: type: object properties: id: type: string link_details: type: array items: $ref: '#/components/schemas/LinkDetail' title: LinkedIntegration BillingEntityDefaultCustomerCountrySelectorItems: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: BillingEntityDefaultCustomerCountrySelectorItems TaxIdValidationValid: type: string enum: - VALID - NOT_VALID - UNKNOWN title: TaxIdValidationValid BillingEntityUpdateRequestDefaultBillingCurrencySelectorItems: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL title: BillingEntityUpdateRequestDefaultBillingCurrencySelectorItems BillingEntityUpdateRequestDefaultCustomerCountrySelectorItems: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: BillingEntityUpdateRequestDefaultCustomerCountrySelectorItems ApiErrorCode: type: string enum: - RESOURCE_NOT_FOUND - RESOURCES_NOT_FOUND - UNABLE_TO_PROCESS_INSTRUCTIONS - BAD_REQUEST - UNSUPPORTED_MEDIA_TYPE - RESOURCE_ALREADY_EXISTS - CUSTOM_FIELD_VALUE_ALREADY_EXISTS - COULD_NOT_CREATE_RESOURCE - COULD_NOT_UPDATE_RESOURCE - COULD_NOT_DELETE_RESOURCE - MISSING_VERSION - UNSUPPORTED_VERSION - UNAUTHORISED - CUSTOMER_NOT_FOUND - PLATFORM_NOT_FOUND - PRICING_PLAN_NOT_FOUND - PRODUCT_NOT_FOUND - PRODUCT_ITEM_NOT_FOUND - PRICING_NOT_FOUND - PRICING_ITEM_NOT_FOUND - USER_NOT_FOUND - METER_NOT_FOUND - METER_VALUE_NOT_FOUND - METER_PROPERTY_NOT_FOUND - PRICING_ITEM_SUMMARIES_NOT_FOUND - MISSING_ID - INVALID_ID - MISSING_REFERENCE - MISSING_FIELD - INVALID_FIELD - INVALID_OPERATION - INTERNAL_ERROR - USER_NOT_ALLOWED - IDEMPOTENCY_CHECK_FAILED - INVALID_REQUEST title: ApiErrorCode ApiError: type: object properties: type: $ref: '#/components/schemas/ApiErrorType' code: $ref: '#/components/schemas/ApiErrorCode' field: type: - string - 'null' message: type: string resource_id: type: - string - 'null' resource_type: oneOf: - $ref: '#/components/schemas/ApiErrorResourceType' - type: 'null' required: - type - code - message title: ApiError CustomFieldValueCreateRequest: type: object properties: id: type: - string - 'null' description: Resource ID of type CUSTOM_FIELD reference: type: - string - 'null' value: type: - string - 'null' values: type: - array - 'null' items: type: string integration_details: oneOf: - $ref: '#/components/schemas/IntegrationDetails' - type: 'null' integration_id: type: string description: The resource ID of the integration linked to the custom field title: CustomFieldValueCreateRequest BillingEntityResponseWrapper: type: object properties: data: type: array items: $ref: '#/components/schemas/BillingEntity' required: - data title: BillingEntityResponseWrapper IntegrationDetails: type: object properties: id: type: - string - 'null' reference: type: - string - 'null' payment_gateway_variant: $ref: '#/components/schemas/IntegrationDetailsPaymentGatewayVariant' adyen: $ref: '#/components/schemas/AdyenIntegrationDetails' stripe: $ref: '#/components/schemas/StripeIntegrationDetails' title: IntegrationDetails TaxSettingsCreateRequest: type: object properties: apply_local_vat_for_missing_tax_id: type: boolean description: Indicates whether to apply VAT when a foreign B2B customer inside the EU has no VAT id configured title: TaxSettingsCreateRequest TaxIdType: type: string enum: - GENERIC_TAX_ID - AU_GST - CA_GST_HST - CA_PST - CA_PST_BC - CA_PST_MB - CA_PST_SK - CA_QST description: Optional tax id type, indicates which type of tax the number is for title: TaxIdType CustomFieldValue: type: object properties: id: type: - string - 'null' description: Resource ID of type CUSTOM_FIELD reference: type: - string - 'null' value: type: - string - 'null' values: type: - array - 'null' items: type: string integration_details: oneOf: - $ref: '#/components/schemas/IntegrationDetails' - type: 'null' integration_id: type: string description: The resource ID of the integration linked to the custom field title: CustomFieldValue AddressCreateRequest: type: object properties: line1: type: - string - 'null' line2: type: - string - 'null' city: type: - string - 'null' postal_code: type: - string - 'null' state: type: - string - 'null' country: oneOf: - $ref: '#/components/schemas/AddressCreateRequestCountry' - type: 'null' title: AddressCreateRequest ApiErrorType: type: string enum: - API_ERROR - INVALID_REQUEST title: ApiErrorType BillingEntityUpdateRequest: type: object properties: object_type: type: - string - 'null' id: type: - string - 'null' created_at: type: - string - 'null' reference: type: string status: type: - string - 'null' timezone: type: - string - 'null' legal_name: type: - string - 'null' description: The legal name of the billing entity. tax_id: type: - string - 'null' description: The ID used for tax purposes of the billing entity. tax_ids: type: - array - 'null' items: $ref: '#/components/schemas/TaxId' description: Tax IDs used for tax purposes of the billing entity registration_number: type: - string - 'null' description: The registration number of the billing entity. registered_address: $ref: '#/components/schemas/Address' description: The address associated with the billing entity. email: type: - string - 'null' description: The email address of the billing entity. tax_settings: $ref: '#/components/schemas/TaxSettings' description: Customise tax settings for this Billing Entity tax_registrations: type: - array - 'null' items: $ref: '#/components/schemas/TaxRegistration' description: Extra tax registrations for this billing entity custom_fields: type: - array - 'null' items: $ref: '#/components/schemas/CustomFieldValue' default_customer_country_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityUpdateRequestDefaultCustomerCountrySelectorItems' default_billing_currency_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityUpdateRequestDefaultBillingCurrencySelectorItems' linked_integrations: type: - array - 'null' items: $ref: '#/components/schemas/LinkedIntegration' title: BillingEntityUpdateRequest BillingEntityCreateRequestDefaultBillingCurrencySelectorItems: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL title: BillingEntityCreateRequestDefaultBillingCurrencySelectorItems TaxIdCreateRequest: type: object properties: id: type: string type: oneOf: - $ref: '#/components/schemas/TaxIdCreateRequestType' - type: 'null' description: Optional tax id type, indicates which type of tax the number is for display_name: type: - string - 'null' description: User-friendly display name tax_id_validation_result: $ref: '#/components/schemas/TaxIdValidation' title: TaxIdCreateRequest TaxIdCreateRequestType: type: string enum: - GENERIC_TAX_ID - AU_GST - CA_GST_HST - CA_PST - CA_PST_BC - CA_PST_MB - CA_PST_SK - CA_QST description: Optional tax id type, indicates which type of tax the number is for title: TaxIdCreateRequestType BillingEntityDefaultBillingCurrencySelectorItems: type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UZS - VEF - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL title: BillingEntityDefaultBillingCurrencySelectorItems TaxRegistrationCreateRequest: type: object properties: id: type: - string - 'null' description: The id of this tax registration description: type: - string - 'null' description: The description of this tax registration tax_id: type: - string - 'null' description: The tax id of this tax registration, e.g. a TIN, VAT id or other tax number tax_ids: type: - array - 'null' items: $ref: '#/components/schemas/TaxId' description: Tax IDs used for tax purposes of the tax registration, e.g. TINs, VAT ids, or other tax number registration_number: type: - string - 'null' description: The registration number of this tax registration, e.g. a company registration number registered_address: $ref: '#/components/schemas/Address' description: The address of this tax registration, if different from the billing entity. Currently, only the address will be used for tax calculations title: TaxRegistrationCreateRequest BillingEntityCreateRequest: type: object properties: object_type: type: - string - 'null' id: type: - string - 'null' created_at: type: - string - 'null' reference: type: string status: type: - string - 'null' timezone: type: - string - 'null' legal_name: type: - string - 'null' description: The legal name of the billing entity. tax_id: type: - string - 'null' description: The ID used for tax purposes of the billing entity. tax_ids: type: - array - 'null' items: $ref: '#/components/schemas/TaxIdCreateRequest' description: Tax IDs used for tax purposes of the billing entity registration_number: type: - string - 'null' description: The registration number of the billing entity. registered_address: $ref: '#/components/schemas/AddressCreateRequest' description: The address associated with the billing entity. email: type: - string - 'null' description: The email address of the billing entity. tax_settings: $ref: '#/components/schemas/TaxSettingsCreateRequest' description: Customise tax settings for this Billing Entity tax_registrations: type: - array - 'null' items: $ref: '#/components/schemas/TaxRegistrationCreateRequest' description: Extra tax registrations for this billing entity custom_fields: type: - array - 'null' items: $ref: '#/components/schemas/CustomFieldValueCreateRequest' default_customer_country_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityCreateRequestDefaultCustomerCountrySelectorItems' default_billing_currency_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityCreateRequestDefaultBillingCurrencySelectorItems' linked_integrations: type: - array - 'null' items: $ref: '#/components/schemas/LinkedIntegrationCreateRequest' required: - reference title: BillingEntityCreateRequest AddressCreateRequestCountry: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: AddressCreateRequestCountry ApiErrorResourceType: type: string enum: - CUSTOMER - CUSTOM_FIELD - PLATFORM - PLATFORM_UPTODATE - METER - METER_VALUE - METER_PROPERTY - METER_VALUE_CALCULATION - INGEST_DATA - METER_DATA - CHARGE_DATA - PERSIST_DATA - ADJUSTMENT_DATA - PRODUCT_CATEGORY - PRODUCT - PRODUCT_ITEM - PRICING - PRICING_GROUP - PRICING_ITEM - PRICING_ITEM_CONFIG - PRICING_PLAN_SUBSCRIPTION - PRICING_PLAN_SUBSCRIPTION_GROUP - PRICING_PLAN_SCHEDULE - PRICING_PLAN - PRICING_PLAN_VERSION - QUOTE - QUOTE_VERSION - QUOTE_TEMPLATE - API_KEY - USER - ROLE - PROXY_USER - EXTERNAL_CREDENTIALS - TOKEN - INVOICE - E_INVOICE - PDF - BILLING_ENTITY - FEATURE - MEMBERSHIP - PAYMENT - PAYMENT_ACCEPTOR - PAYMENT_METHOD - PAYMENT_METHOD_OPTIONS - PAYMENT_SCHEDULE - PAYMENT_REQUEST - INTEGRATION - WEBHOOK - FILE - FILE_PROCESSING_SETTINGS - TEAM - DOWNLOAD_URL - CSV_REPORT - REPORT - REPORT_GENERATE_REQUEST - REPORT_CONFIGURATION - REPORT_SUBSCRIPTION - REPORT_DEFINITION - ACCOUNT_GROUP - ENTITY - EVENT_TRACE - EVENT_TRACE_LINK - PRICING_CATEGORY - CONTACT - ALERT_RULE - ALERT - AUDIT_RECORD - PORTAL_URL - AUTHENTICATION_PROVIDER - REPROCESS - APPROVAL_POLICY - APPROVAL_REQUEST - BULK_ACTION - COUPON - PROMOTION_CODE - WALLET - WALLET_TYPE - WALLET_GRANT - WORKFLOW - WORKFLOW_TRIGGER - WORKFLOW_ACTION - CREDIT_TYPE - SIGNATURE_REQUEST - ATTACHMENT - DOCUMENT title: ApiErrorResourceType TaxRegistration: type: object properties: id: type: - string - 'null' description: The id of this tax registration description: type: - string - 'null' description: The description of this tax registration tax_id: type: - string - 'null' description: The tax id of this tax registration, e.g. a TIN, VAT id or other tax number tax_ids: type: - array - 'null' items: $ref: '#/components/schemas/TaxId' description: Tax IDs used for tax purposes of the tax registration, e.g. TINs, VAT ids, or other tax number registration_number: type: - string - 'null' description: The registration number of this tax registration, e.g. a company registration number registered_address: $ref: '#/components/schemas/Address' description: The address of this tax registration, if different from the billing entity. Currently, only the address will be used for tax calculations title: TaxRegistration BillingEntity: type: object properties: object_type: type: - string - 'null' id: type: - string - 'null' created_at: type: - string - 'null' reference: type: string status: type: - string - 'null' timezone: type: - string - 'null' legal_name: type: - string - 'null' description: The legal name of the billing entity. tax_id: type: - string - 'null' description: The ID used for tax purposes of the billing entity. tax_ids: type: - array - 'null' items: $ref: '#/components/schemas/TaxId' description: Tax IDs used for tax purposes of the billing entity registration_number: type: - string - 'null' description: The registration number of the billing entity. registered_address: $ref: '#/components/schemas/Address' description: The address associated with the billing entity. email: type: - string - 'null' description: The email address of the billing entity. tax_settings: $ref: '#/components/schemas/TaxSettings' description: Customise tax settings for this Billing Entity tax_registrations: type: - array - 'null' items: $ref: '#/components/schemas/TaxRegistration' description: Extra tax registrations for this billing entity custom_fields: type: - array - 'null' items: $ref: '#/components/schemas/CustomFieldValue' default_customer_country_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityDefaultCustomerCountrySelectorItems' default_billing_currency_selector: type: - array - 'null' items: $ref: '#/components/schemas/BillingEntityDefaultBillingCurrencySelectorItems' linked_integrations: type: - array - 'null' items: $ref: '#/components/schemas/LinkedIntegration' title: BillingEntity Address: type: object properties: line1: type: - string - 'null' line2: type: - string - 'null' city: type: - string - 'null' postal_code: type: - string - 'null' state: type: - string - 'null' country: oneOf: - $ref: '#/components/schemas/AddressCountry' - type: 'null' title: Address TaxSettings: type: object properties: apply_local_vat_for_missing_tax_id: type: boolean description: Indicates whether to apply VAT when a foreign B2B customer inside the EU has no VAT id configured title: TaxSettings IntegrationDetailsPaymentGatewayVariant: type: string enum: - ADYEN - STRIPE title: IntegrationDetailsPaymentGatewayVariant BillingEntityCreateRequestDefaultCustomerCountrySelectorItems: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: BillingEntityCreateRequestDefaultCustomerCountrySelectorItems TaxId: type: object properties: id: type: string type: oneOf: - $ref: '#/components/schemas/TaxIdType' - type: 'null' description: Optional tax id type, indicates which type of tax the number is for display_name: type: - string - 'null' description: User-friendly display name tax_id_validation_result: $ref: '#/components/schemas/TaxIdValidation' title: TaxId AdyenIntegrationDetails: type: object properties: recurring_detail_reference: type: string title: AdyenIntegrationDetails StripeIntegrationDetails: type: object properties: payment_method_id: type: string title: StripeIntegrationDetails TaxIdValidation: type: object properties: id: type: string validation_date: type: string source: type: string valid: $ref: '#/components/schemas/TaxIdValidationValid' message: type: - string - 'null' title: TaxIdValidation LinkedIntegrationCreateRequest: type: object properties: id: type: string link_details: type: array items: $ref: '#/components/schemas/LinkDetail' title: LinkedIntegrationCreateRequest LinkDetail: type: object properties: url: type: - string - 'null' custom_field_name: type: - string - 'null' title: LinkDetail AddressCountry: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: AddressCountry securitySchemes: API-Key: type: apiKey in: header name: X-API-KEY JWT-Authentication: type: http scheme: bearer