# Delete Billing Profile

Delete Billing Profile

Endpoint: DELETE /rest/2.0/delete/BILLING_PROFILE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.Id` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.CreditCardExpDate` (string)
    Credit Card Exp Date (MM/YYYY)

  - `retrieveResponse.Country` (string)
    Country

  - `retrieveResponse.InvoiceDeliveryMethod` (string)
    Invoice Delivery Method: Select how the invoice is delivered to the account. Choose between Mail or Email.

  - `retrieveResponse.DunningInterval` (string)
    Dunning Process: Select a dunning strategy to use on this account should it become delinquent.

  - `retrieveResponse.AllowPricingInOtherCurrency` (integer)
    Allow Pricing In Different Currency

  - `retrieveResponse.AchBankAbaCode` (string)
    ACH Routing Number

  - `retrieveResponse.AchBankAcctType` (string)
    ACH Account Type

  - `retrieveResponse.DisablePDFGenerationOnInvoiceClose` (integer)
    Disable PDF Generation on Invoice Close: When this option is selected, no invoice PDF will be generated during the invoice close process. If an invoice PDF is needed after invoice close, users can navigate to the invoice page to generate the PDF utilizing the Invoice Template defined at the Account

  - `retrieveResponse.InvoiceTemplateId` (integer)
    Invoice Template

  - `retrieveResponse.PaymentTermDays` (string)
    Payment Terms (Net): Indicates the number of days from when the invoice is closed to when the payment is expected. This is the same as the 'Payment Due Date' sections of common subscription invoices. If a customer has a default credit card or direct debit payment method saved for payments, the system will attempt to process the payment via the default payment method after the # of days indicated in the field lapses.

  - `retrieveResponse.CreditCardType` (string)
    Credit Card Type

  - `retrieveResponse.CreditCardName` (string)
    Card Holder Name

  - `retrieveResponse.Phone` (string)
    Phone

  - `retrieveResponse.InvoiceFileFormat` (string)
    Invoice File Format: Specify a file format to override the default format from the invoice template. Leave this field empty to use the template's format.

  - `retrieveResponse.AchMandateStatus` (string)
    Mandate Status

  - `retrieveResponse.ECreditTemplate` (integer)
    E-invoice Credit Template

  - `retrieveResponse.Address2` (string)
    Addr2

  - `retrieveResponse.CurrencyCode` (integer)
    Invoice Currency: Specifies the currency applied to invoices. Changing the value of this field triggers a re-rate of current invoices to the new currency.

  - `retrieveResponse.StatementApprovalFlag` (integer)
    Approve Statements Before Delivery

  - `retrieveResponse.StatementTemplateId` (string)
    Statement Template

  - `retrieveResponse.StatementDeliveryMethod` (string)
    Statement Delivery Method

  - `retrieveResponse.PeriodCutoffDate` (string)
    Period Cutoff Date: Billable transactions can`t be booked prior to this date. This date is advanced or retreated by opening or closing invoice periods

  - `retrieveResponse.AchBranchCode` (string)
    Branch Code

  - `retrieveResponse.AchScheme` (string)
    Direct Debit Scheme

  - `retrieveResponse.NationalIdentityNumber` (string)
    National Identity Number

  - `retrieveResponse.Email` (string)
    Email: Specify the email address to which invoices are addressed. Invoices will not be sent to the specified email address until EMAIL is selected for the Invoice Delivery Method under Billing Profile Information.

  - `retrieveResponse.CreditCardCCV` (string)
    Credit Card CCV

  - `retrieveResponse.AchBankAcctName` (string)
    ACH Name on Account

  - `retrieveResponse.StatementEarliestDate` (string)
    Statement Earliest Date: When this date is set, no statement will be generated until this date

  - `retrieveResponse.BillTo` (string)
    Bill To: Indicates the name to which bills are addressed to. This is what typically appears on the invoice PDFs that are generated out of the system.

  - `retrieveResponse.BillingCycle` (string)
    Default Billing Cycle: Indicates the default billing cycle that will be used for the account. This can be overridden if event-based billing is enabled.

  - `retrieveResponse.PoNumber` (string)
    PO Number

  - `retrieveResponse.Fax` (string)
    Fax

  - `retrieveResponse.TimeZoneId` (string)
    Invoicing Time Zone: Specifies the time zone used for invoice close, rate start/ end, and service start/end time.

  - `retrieveResponse.AchMandateCountry` (string)
    Mandate Country

  - `retrieveResponse.YearlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `retrieveResponse.CalendarClosingMonth` (string)
    Calendar Closing Month

  - `retrieveResponse.SemiAnnualBillingMonth` (string)
    Billing Cycle Closing Month

  - `retrieveResponse.Attention` (string)
    Attn

  - `retrieveResponse.Address1` (string)
    Addr1

  - `retrieveResponse.InvoiceApprovalFlag` (integer)
    Approve invoices before delivery

  - `retrieveResponse.WeeklyBillingDate` (string)
    Bill Cycle Schedule

  - `retrieveResponse.QuarterlyBillingMonth` (string)
    Billing Cycle Closing Month: For quarterly and annual invoices specifies the month in which invoice close will happen

  - `retrieveResponse.EInvoiceTemplate` (integer)
    E-invoice Template

  - `retrieveResponse.MonthlyBillingDate` (string)
    Billing Cycle Closing Day

  - `retrieveResponse.State` (string)
    State

  - `retrieveResponse.Zip` (string)
    Zip

  - `retrieveResponse.EventGroupType` (string)
    Close Invoice every

  - `retrieveResponse.AchBankAcctNum` (string)
    ACH Account Number

  - `retrieveResponse.AchBankName` (string)
    ACH Bank Name

  - `retrieveResponse.CreditCardToken` (string)
    CreditCardToken

  - `retrieveResponse.AchUniqueRef` (string)
    Unique Reference

  - `retrieveResponse.TaxEngineId` (integer)
    Tax Engine

  - `retrieveResponse.AchMandateReference` (string)
    Mandate Reference

  - `retrieveResponse.BillingMethod` (string)
    Payment Method: This is the method of accepting payments into the account. Additional fields will become available to fill up depending on the type of method selected (i.e., credit card information, checking information, etc.)

  - `retrieveResponse.CreditCardNumber` (string)
    Credit Card Number

  - `retrieveResponse.City` (string)
    City

  - `retrieveResponse.StatementCycle` (string)
    Statement Cycle

  - `retrieveResponse.ManualCloseFlag` (integer)
    Manual Closing: Indicates whether the invoices generated after the billing cycle require manual closing.If selected, invoices remain in the Current status after the billing period ends. The closing action must be triggered manually.If not selected (default), invoices are automatically closed on their close date.

  - `retrieveResponse.EventBasedBilling` (integer)
    Allow Event Based Billing

  - `retrieveResponse.PaymentGatewayCustomerId` (string)
    Payment Gateway Customer Extenal Key

  - `retrieveResponse.AchMandateState` (string)
    Mandate State

  - `retrieveResponse.HostedPaymentPageExternalId` (string)
    HostedPaymentPage External Id

  - `retrieveResponse.Id` (string)
    Own Billing Profile Id: BILLING_PROFILE_ID

  - `retrieveResponse.CalendarType` (string)
    Calendar Type

  - `retrieveResponse.CalendarClosingWeekday` (string)
    Billing Cycle Closing Weekday

  - `retrieveResponse.EInvoiceProfile` (integer)
    E-invoice Profile

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.InvGraceDaysBeforeClosing` (string)
    InvGraceDaysBeforeClosing: Invoice Grace before Close

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.BillingEntity` (string)
    BillingEntity: Billnge Entity

  - `retrieveResponse.AchMandateEnabledFlag` (integer)
    AchMandateEnabledFlag: Mandate Enabled Flag

  - `retrieveResponse.AchMandateStatusModifyDate` (string)
    AchMandateStatusModifyDate: Mandate Status Modify Date

  - `retrieveResponse.CustomerRefNum` (string)
    CustomerRefNum: Customer Reference Number

  - `retrieveResponse.AccountId` (integer)
    Account Id: Account

  - `retrieveResponse.AchEcheckType` (string)
    ACH Echeck Type

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error