API Reference (1.0)
Billing Platform API
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE/{id}
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "AccountId": null, "AchBankAbaCode": null, "AchBankAcctName": null, "AchBankAcctNum": null, "AchBankAcctType": null, "AchBankName": null, "AchBranchCode": null, "AchEcheckType": null, "AchMandateCountry": null, "AchMandateEnabledFlag": null, "AchMandateReference": null, "AchMandateState": null, "AchMandateStatus": null, "AchMandateStatusModifyDate": null, "AchScheme": null, "AchUniqueRef": null, "Address1": null, "Address2": null, "AllowPricingInOtherCurrency": null, "Attention": null, "BillTo": null, "BillingCycle": null, "BillingEntity": null, "BillingMethod": null, "CalendarClosingMonth": null, "CalendarClosingWeekday": null, "CalendarType": null, "City": null, "Country": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditCardToken": null, "CreditCardType": null, "CurrencyCode": null, "CustomerRefNum": null, "DisablePDFGenerationOnInvoiceClose": null, "DunningInterval": null, "ECreditTemplate": null, "EInvoiceProfile": null, "EInvoiceTemplate": null, "Email": null, "EventBasedBilling": null, "EventGroupType": null, "Fax": null, "HostedPaymentPageExternalId": null, "Id": null, "InvGraceDaysBeforeClosing": null, "InvoiceApprovalFlag": null, "InvoiceDeliveryMethod": null, "InvoiceFileFormat": null, "InvoiceTemplateId": null, "ManualCloseFlag": null, "MonthlyBillingDate": null, "NationalIdentityNumber": null, "PaymentCreditAllocationMethod": null, "PaymentGatewayCustomerId": null, "PaymentTermDays": null, "PeriodCutoffDate": null, "Phone": null, "PoNumber": null, "QuarterlyBillingMonth": null, "SemiAnnualBillingMonth": null, "State": null, "StatementApprovalFlag": null, "StatementCycle": null, "StatementDeliveryMethod": null, "StatementEarliestDate": null, "StatementTemplateId": null, "Status": null, "TaxEngineId": null, "TimeZoneId": null, "Updated": null, "UpdatedUserId": null, "WeeklyBillingDate": null, "YearlyBillingMonth": null, "Zip": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "AccountId": null, "AchBankAbaCode": null, "AchBankAcctName": null, "AchBankAcctNum": null, "AchBankAcctType": null, "AchBankName": null, "AchBranchCode": null, "AchEcheckType": null, "AchMandateCountry": null, "AchMandateEnabledFlag": null, "AchMandateReference": null, "AchMandateState": null, "AchMandateStatus": null, "AchMandateStatusModifyDate": null, "AchScheme": null, "AchUniqueRef": null, "Address1": null, "Address2": null, "AllowPricingInOtherCurrency": null, "Attention": null, "BillTo": null, "BillingCycle": null, "BillingEntity": null, "BillingMethod": null, "CalendarClosingMonth": null, "CalendarClosingWeekday": null, "CalendarType": null, "City": null, "Country": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditCardToken": null, "CreditCardType": null, "CurrencyCode": null, "CustomerRefNum": null, "DisablePDFGenerationOnInvoiceClose": null, "DunningInterval": null, "ECreditTemplate": null, "EInvoiceProfile": null, "EInvoiceTemplate": null, "Email": null, "EventBasedBilling": null, "EventGroupType": null, "Fax": null, "HostedPaymentPageExternalId": null, "Id": null, "InvGraceDaysBeforeClosing": null, "InvoiceApprovalFlag": null, "InvoiceDeliveryMethod": null, "InvoiceFileFormat": null, "InvoiceTemplateId": null, "ManualCloseFlag": null, "MonthlyBillingDate": null, "NationalIdentityNumber": null, "PaymentCreditAllocationMethod": null, "PaymentGatewayCustomerId": null, "PaymentTermDays": null, "PeriodCutoffDate": null, "Phone": null, "PoNumber": null, "QuarterlyBillingMonth": null, "SemiAnnualBillingMonth": null, "State": null, "StatementApprovalFlag": null, "StatementCycle": null, "StatementDeliveryMethod": null, "StatementEarliestDate": null, "StatementTemplateId": null, "Status": null, "TaxEngineId": null, "TimeZoneId": null, "Updated": null, "UpdatedUserId": null, "WeeklyBillingDate": null, "YearlyBillingMonth": null, "Zip": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AchBankAbaCode": null,
"AchBankAcctName": null,
"AchBankAcctNum": null,
"AchBankAcctType": null,
"AchBankName": null,
"AchBranchCode": null,
"AchEcheckType": null,
"AchMandateCountry": null,
"AchMandateEnabledFlag": null,
"AchMandateReference": null,
"AchMandateState": null,
"AchMandateStatus": null,
"AchMandateStatusModifyDate": null,
"AchScheme": null,
"AchUniqueRef": null,
"Address1": null,
"Address2": null,
"AllowPricingInOtherCurrency": null,
"Attention": null,
"BillTo": null,
"BillingCycle": null,
"BillingEntity": null,
"BillingMethod": null,
"CalendarClosingMonth": null,
"CalendarClosingWeekday": null,
"CalendarType": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardType": null,
"CurrencyCode": null,
"CustomerRefNum": null,
"DisablePDFGenerationOnInvoiceClose": null,
"DunningInterval": null,
"ECreditTemplate": null,
"EInvoiceProfile": null,
"EInvoiceTemplate": null,
"Email": null,
"EventBasedBilling": null,
"EventGroupType": null,
"Fax": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvGraceDaysBeforeClosing": null,
"InvoiceApprovalFlag": null,
"InvoiceDeliveryMethod": null,
"InvoiceFileFormat": null,
"InvoiceTemplateId": null,
"ManualCloseFlag": null,
"MonthlyBillingDate": null,
"NationalIdentityNumber": null,
"PaymentCreditAllocationMethod": null,
"PaymentGatewayCustomerId": null,
"PaymentTermDays": null,
"PeriodCutoffDate": null,
"Phone": null,
"PoNumber": null,
"QuarterlyBillingMonth": null,
"SemiAnnualBillingMonth": null,
"State": null,
"StatementApprovalFlag": null,
"StatementCycle": null,
"StatementDeliveryMethod": null,
"StatementEarliestDate": null,
"StatementTemplateId": null,
"Status": null,
"TaxEngineId": null,
"TimeZoneId": null,
"Updated": null,
"UpdatedUserId": null,
"WeeklyBillingDate": null,
"YearlyBillingMonth": null,
"Zip": null
}
}'
{ "updateResponse": [ { … } ] }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE/{id}
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE/{id}
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "AccountId": null, "AchBankAbaCode": null, "AchBankAcctName": null, "AchBankAcctNum": null, "AchBankAcctType": null, "AchBankName": null, "AchBranchCode": null, "AchEcheckType": null, "AchMandateCountry": null, "AchMandateEnabledFlag": null, "AchMandateReference": null, "AchMandateState": null, "AchMandateStatus": null, "AchMandateStatusModifyDate": null, "AchScheme": null, "AchUniqueRef": null, "Address1": null, "Address2": null, "AllowPricingInOtherCurrency": null, "Attention": null, "BillTo": null, "BillingCycle": null, "BillingEntity": null, "BillingMethod": null, "CalendarClosingMonth": null, "CalendarClosingWeekday": null, "CalendarType": null, "City": null, "Country": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditCardToken": null, "CreditCardType": null, "CurrencyCode": null, "CustomerRefNum": null, "DisablePDFGenerationOnInvoiceClose": null, "DunningInterval": null, "ECreditTemplate": null, "EInvoiceProfile": null, "EInvoiceTemplate": null, "Email": null, "EventBasedBilling": null, "EventGroupType": null, "Fax": null, "HostedPaymentPageExternalId": null, "Id": null, "InvGraceDaysBeforeClosing": null, "InvoiceApprovalFlag": null, "InvoiceDeliveryMethod": null, "InvoiceFileFormat": null, "InvoiceTemplateId": null, "ManualCloseFlag": null, "MonthlyBillingDate": null, "NationalIdentityNumber": null, "PaymentCreditAllocationMethod": null, "PaymentGatewayCustomerId": null, "PaymentTermDays": null, "PeriodCutoffDate": null, "Phone": null, "PoNumber": null, "QuarterlyBillingMonth": null, "SemiAnnualBillingMonth": null, "State": null, "StatementApprovalFlag": null, "StatementCycle": null, "StatementDeliveryMethod": null, "StatementEarliestDate": null, "StatementTemplateId": null, "Status": null, "TaxEngineId": null, "TimeZoneId": null, "Updated": null, "UpdatedUserId": null, "WeeklyBillingDate": null, "YearlyBillingMonth": null, "Zip": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X GET \
'https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'
{ "retrieveResponse": { "AccountId": null, "AchBankAbaCode": null, "AchBankAcctName": null, "AchBankAcctNum": null, "AchBankAcctType": null, "AchBankName": null, "AchBranchCode": null, "AchEcheckType": null, "AchMandateCountry": null, "AchMandateEnabledFlag": null, "AchMandateReference": null, "AchMandateState": null, "AchMandateStatus": null, "AchMandateStatusModifyDate": null, "AchScheme": null, "AchUniqueRef": null, "Address1": null, "Address2": null, "AllowPricingInOtherCurrency": null, "Attention": null, "BillTo": null, "BillingCycle": null, "BillingEntity": null, "BillingMethod": null, "CalendarClosingMonth": null, "CalendarClosingWeekday": null, "CalendarType": null, "City": null, "Country": null, "Created": null, "CreatedUserId": null, "CreditCardCCV": null, "CreditCardExpDate": null, "CreditCardName": null, "CreditCardNumber": null, "CreditCardToken": null, "CreditCardType": null, "CurrencyCode": null, "CustomerRefNum": null, "DisablePDFGenerationOnInvoiceClose": null, "DunningInterval": null, "ECreditTemplate": null, "EInvoiceProfile": null, "EInvoiceTemplate": null, "Email": null, "EventBasedBilling": null, "EventGroupType": null, "Fax": null, "HostedPaymentPageExternalId": null, "Id": null, "InvGraceDaysBeforeClosing": null, "InvoiceApprovalFlag": null, "InvoiceDeliveryMethod": null, "InvoiceFileFormat": null, "InvoiceTemplateId": null, "ManualCloseFlag": null, "MonthlyBillingDate": null, "NationalIdentityNumber": null, "PaymentCreditAllocationMethod": null, "PaymentGatewayCustomerId": null, "PaymentTermDays": null, "PeriodCutoffDate": null, "Phone": null, "PoNumber": null, "QuarterlyBillingMonth": null, "SemiAnnualBillingMonth": null, "State": null, "StatementApprovalFlag": null, "StatementCycle": null, "StatementDeliveryMethod": null, "StatementEarliestDate": null, "StatementTemplateId": null, "Status": null, "TaxEngineId": null, "TimeZoneId": null, "Updated": null, "UpdatedUserId": null, "WeeklyBillingDate": null, "YearlyBillingMonth": null, "Zip": null } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE
https://my.billingplatform.com/demogm/rest/2.0/BILLING_PROFILE
- cURL
- JS
- Go
- Ruby
- Java 8
curl -i -X PUT \
https://bp-api-docs-v3.redocly.app/_mock/demogm_20250725_full_schema/rest/2.0/BILLING_PROFILE \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'sessionId: string' \
-d '{
"brmObjects": {
"AccountId": null,
"AchBankAbaCode": null,
"AchBankAcctName": null,
"AchBankAcctNum": null,
"AchBankAcctType": null,
"AchBankName": null,
"AchBranchCode": null,
"AchEcheckType": null,
"AchMandateCountry": null,
"AchMandateEnabledFlag": null,
"AchMandateReference": null,
"AchMandateState": null,
"AchMandateStatus": null,
"AchMandateStatusModifyDate": null,
"AchScheme": null,
"AchUniqueRef": null,
"Address1": null,
"Address2": null,
"AllowPricingInOtherCurrency": null,
"Attention": null,
"BillTo": null,
"BillingCycle": null,
"BillingEntity": null,
"BillingMethod": null,
"CalendarClosingMonth": null,
"CalendarClosingWeekday": null,
"CalendarType": null,
"City": null,
"Country": null,
"Created": null,
"CreatedUserId": null,
"CreditCardCCV": null,
"CreditCardExpDate": null,
"CreditCardName": null,
"CreditCardNumber": null,
"CreditCardToken": null,
"CreditCardType": null,
"CurrencyCode": null,
"CustomerRefNum": null,
"DisablePDFGenerationOnInvoiceClose": null,
"DunningInterval": null,
"ECreditTemplate": null,
"EInvoiceProfile": null,
"EInvoiceTemplate": null,
"Email": null,
"EventBasedBilling": null,
"EventGroupType": null,
"Fax": null,
"HostedPaymentPageExternalId": null,
"Id": null,
"InvGraceDaysBeforeClosing": null,
"InvoiceApprovalFlag": null,
"InvoiceDeliveryMethod": null,
"InvoiceFileFormat": null,
"InvoiceTemplateId": null,
"ManualCloseFlag": null,
"MonthlyBillingDate": null,
"NationalIdentityNumber": null,
"PaymentCreditAllocationMethod": null,
"PaymentGatewayCustomerId": null,
"PaymentTermDays": null,
"PeriodCutoffDate": null,
"Phone": null,
"PoNumber": null,
"QuarterlyBillingMonth": null,
"SemiAnnualBillingMonth": null,
"State": null,
"StatementApprovalFlag": null,
"StatementCycle": null,
"StatementDeliveryMethod": null,
"StatementEarliestDate": null,
"StatementTemplateId": null,
"Status": null,
"TaxEngineId": null,
"TimeZoneId": null,
"Updated": null,
"UpdatedUserId": null,
"WeeklyBillingDate": null,
"YearlyBillingMonth": null,
"Zip": null
}
}'
{ "updateResponse": [ { … } ] }