Billing Platform API
API Reference (1.0)
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/
https://my.billingplatform.com/demogm/
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/BILLING_PROFILE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/BILLING_PROFILE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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 POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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": {
"DisablePDFGenerationOnInvoiceClose": 0,
"SemiAnnualBillingMonth": "string",
"Attention": "string",
"MonthlyBillingDate": "string",
"CreditCardExpDate": "string",
"Address1": "string",
"Address2": "string",
"Country": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Phone": "string",
"Fax": "string",
"Email": "string",
"TimeZoneId": "string",
"InvGraceDaysBeforeClosing": "string",
"PaymentTermDays": "string",
"BillingMethod": "string",
"BillingCycle": "string",
"BillTo": "string",
"InvoiceTemplateId": 0,
"CreditCardType": "string",
"CreditCardName": "string",
"CreditCardNumber": "string",
"CreditCardCCV": "string",
"ManualCloseFlag": 0,
"StatementCycle": "string",
"StatementTemplateId": "string",
"DunningInterval": "string",
"InvoiceDeliveryMethod": "string",
"Id": "string",
"AccountId": 0,
"Status": "string",
"CalendarType": "string",
"CalendarClosingMonth": "string",
"CalendarClosingWeekday": "string",
"Created": "string",
"UpdatedUserId": "string",
"Updated": "string",
"CreatedUserId": "string",
"StatementApprovalFlag": 0,
"InvoiceApprovalFlag": 0,
"EventGroupType": "string",
"PoNumber": "string",
"InvoiceFileFormat": "string",
"AllowPricingInOtherCurrency": 0,
"CreditCardToken": "string",
"BillingEntity": "string",
"AchBankAcctType": "string",
"AchBankAbaCode": "string",
"AchBankAcctName": "string",
"AchBankAcctNum": "string",
"WeeklyBillingDate": "string",
"AchBankName": "string",
"AchEcheckType": "string",
"PeriodCutoffDate": "string",
"TaxEngineId": 0,
"PaymentGatewayCustomerId": "string",
"AchMandateEnabledFlag": 0,
"AchMandateStatus": "string",
"AchMandateStatusModifyDate": "string",
"AchScheme": "string",
"AchBranchCode": "string",
"AchMandateCountry": "string",
"AchMandateState": "string",
"NationalIdentityNumber": "string",
"HostedPaymentPageExternalId": "string",
"CustomerRefNum": "string",
"StatementEarliestDate": "string",
"YearlyBillingMonth": "string",
"QuarterlyBillingMonth": "string",
"PaymentCreditAllocationMethod": "string",
"EInvoiceProfile": 0,
"EInvoiceTemplate": 0,
"ECreditTemplate": 0,
"AchMandateReference": "string",
"CurrencyCode": 0,
"StatementDeliveryMethod": "string",
"EventBasedBilling": 0,
"AchUniqueRef": "string"
}
}'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/BILLING_PROFILE/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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_08_01_2025_schema/rest/2.0/BILLING_PROFILE?queryAnsiSql=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'sessionId: string'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }
- Mock server
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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 POST \
https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_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": {
"DisablePDFGenerationOnInvoiceClose": 0,
"SemiAnnualBillingMonth": "string",
"Attention": "string",
"MonthlyBillingDate": "string",
"CreditCardExpDate": "string",
"Address1": "string",
"Address2": "string",
"Country": "string",
"City": "string",
"State": "string",
"Zip": "string",
"Phone": "string",
"Fax": "string",
"Email": "string",
"TimeZoneId": "string",
"InvGraceDaysBeforeClosing": "string",
"PaymentTermDays": "string",
"BillingMethod": "string",
"BillingCycle": "string",
"BillTo": "string",
"InvoiceTemplateId": 0,
"CreditCardType": "string",
"CreditCardName": "string",
"CreditCardNumber": "string",
"CreditCardCCV": "string",
"ManualCloseFlag": 0,
"StatementCycle": "string",
"StatementTemplateId": "string",
"DunningInterval": "string",
"InvoiceDeliveryMethod": "string",
"Id": "string",
"AccountId": 0,
"Status": "string",
"CalendarType": "string",
"CalendarClosingMonth": "string",
"CalendarClosingWeekday": "string",
"Created": "string",
"UpdatedUserId": "string",
"Updated": "string",
"CreatedUserId": "string",
"StatementApprovalFlag": 0,
"InvoiceApprovalFlag": 0,
"EventGroupType": "string",
"PoNumber": "string",
"InvoiceFileFormat": "string",
"AllowPricingInOtherCurrency": 0,
"CreditCardToken": "string",
"BillingEntity": "string",
"AchBankAcctType": "string",
"AchBankAbaCode": "string",
"AchBankAcctName": "string",
"AchBankAcctNum": "string",
"WeeklyBillingDate": "string",
"AchBankName": "string",
"AchEcheckType": "string",
"PeriodCutoffDate": "string",
"TaxEngineId": 0,
"PaymentGatewayCustomerId": "string",
"AchMandateEnabledFlag": 0,
"AchMandateStatus": "string",
"AchMandateStatusModifyDate": "string",
"AchScheme": "string",
"AchBranchCode": "string",
"AchMandateCountry": "string",
"AchMandateState": "string",
"NationalIdentityNumber": "string",
"HostedPaymentPageExternalId": "string",
"CustomerRefNum": "string",
"StatementEarliestDate": "string",
"YearlyBillingMonth": "string",
"QuarterlyBillingMonth": "string",
"PaymentCreditAllocationMethod": "string",
"EInvoiceProfile": 0,
"EInvoiceTemplate": 0,
"ECreditTemplate": 0,
"AchMandateReference": "string",
"CurrencyCode": 0,
"StatementDeliveryMethod": "string",
"EventBasedBilling": 0,
"AchUniqueRef": "string"
}
}'Response
application/json
{ "retrieveResponse": { "DisablePDFGenerationOnInvoiceClose": 0, "SemiAnnualBillingMonth": "string", "Attention": "string", "MonthlyBillingDate": "string", "CreditCardExpDate": "string", "Address1": "string", "Address2": "string", "Country": "string", "City": "string", "State": "string", "Zip": "string", "Phone": "string", "Fax": "string", "Email": "string", "TimeZoneId": "string", "InvGraceDaysBeforeClosing": "string", "PaymentTermDays": "string", "BillingMethod": "string", "BillingCycle": "string", "BillTo": "string", "InvoiceTemplateId": 0, "CreditCardType": "string", "CreditCardName": "string", "CreditCardNumber": "string", "CreditCardCCV": "string", "ManualCloseFlag": 0, "StatementCycle": "string", "StatementTemplateId": "string", "DunningInterval": "string", "InvoiceDeliveryMethod": "string", "Id": "string", "AccountId": 0, "Status": "string", "CalendarType": "string", "CalendarClosingMonth": "string", "CalendarClosingWeekday": "string", "Created": "string", "UpdatedUserId": "string", "Updated": "string", "CreatedUserId": "string", "StatementApprovalFlag": 0, "InvoiceApprovalFlag": 0, "EventGroupType": "string", "PoNumber": "string", "InvoiceFileFormat": "string", "AllowPricingInOtherCurrency": 0, "CreditCardToken": "string", "BillingEntity": "string", "AchBankAcctType": "string", "AchBankAbaCode": "string", "AchBankAcctName": "string", "AchBankAcctNum": "string", "WeeklyBillingDate": "string", "AchBankName": "string", "AchEcheckType": "string", "PeriodCutoffDate": "string", "TaxEngineId": 0, "PaymentGatewayCustomerId": "string", "AchMandateEnabledFlag": 0, "AchMandateStatus": "string", "AchMandateStatusModifyDate": "string", "AchScheme": "string", "AchBranchCode": "string", "AchMandateCountry": "string", "AchMandateState": "string", "NationalIdentityNumber": "string", "HostedPaymentPageExternalId": "string", "CustomerRefNum": "string", "StatementEarliestDate": "string", "YearlyBillingMonth": "string", "QuarterlyBillingMonth": "string", "PaymentCreditAllocationMethod": "string", "EInvoiceProfile": 0, "EInvoiceTemplate": 0, "ECreditTemplate": 0, "AchMandateReference": "string", "CurrencyCode": 0, "StatementDeliveryMethod": "string", "EventBasedBilling": 0, "AchUniqueRef": "string" } }