# Invoice paid

Endpoint: POST invoice-paid
Version: latest
Security: SecretApiKey, JWT

## Request fields (application/json):

  - `invoiceId` (string)
    ID of the invoice.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `eventType` (string)
    Type of event that triggered the webhook.
    Enum: "invoice-abandoned", "invoice-created", "invoice-issued", "invoice-modified", "invoice-paid", "invoice-partially-paid", "invoice-partially-refunded", "invoice-past-due", "invoice-past-due-reminder", "invoice-refunded", "invoice-reissued", "invoice-tax-calculation-failed", "invoice-voided"

  - `_embedded` (object)
    Available embedded objects that are requested by the expand query parameter.

  - `_embedded.invoice` (object)

  - `_embedded.invoice.websiteId` (string, required)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

  - `_embedded.invoice.currency` (string, required)
    Currency code in ISO 4217 format.

  - `_embedded.invoice.shipping` (object) — one of (discriminator: calculator):
    Shipping settings.
    - manual:
      - `amount` (number, required)
        Shipping amount.
      - `calculator` (string, required)
        Shipping calculator.
        Enum: "manual"
    - rebilly:
      - `calculator` (string, required)
        Shipping calculator.
        Enum: "rebilly"
      - `rateId` (string,null)
        ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
        Example: "shipping-123-456"

  - `_embedded.invoice.tax` (object) — one of (discriminator: calculator):
    Taxes.
    - manual:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: same as `calculator` in "manual" (1 values)
      - `items` (array, required)
        Taxes applied.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.
    - rebilly-taxjar:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: "rebilly-taxjar"
      - `items` (array)
        Taxes applied and calculated based on the taxCategoryId of the related product.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.
    - rebilly-avalara:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: "rebilly-avalara"
      - `items` (array)
        Taxes applied and calculated based on the taxCategoryId of the related product.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.

  - `_embedded.invoice.organizationTaxIdNumber` (object,null)
    Organization tax ID number that is displayed on the invoice.

  - `_embedded.invoice.organizationTaxIdNumber.type` (string, required)
    Type of the tax ID number.
    Enum: "eu-vat", "other"

  - `_embedded.invoice.organizationTaxIdNumber.value` (string, required)
    Value of the tax ID number.
    Example: "GB980780684"

  - `_embedded.invoice.customerTaxIdNumber` (object,null)
    Customer tax ID number that is displayed on the invoice.

  - `_embedded.invoice.customerTaxIdNumber.type` (string, required)
    Type of the tax ID number.
    Enum: same as `_embedded.invoice.organizationTaxIdNumber.type` (2 values)

  - `_embedded.invoice.customerTaxIdNumber.value` (string, required)
    Value of the tax ID number.
    Example: "GB980780684"

  - `_embedded.invoice.billingAddress` (object)
    Billing address of the invoice.
After the first payment is made for an invoice, this value cannot be changed.

  - `_embedded.invoice.billingAddress.firstName` (string,null)
    Contact's first name.
    Example: "Benjamin"

  - `_embedded.invoice.billingAddress.lastName` (string,null)
    Contact's last name.
    Example: "Franklin"

  - `_embedded.invoice.billingAddress.organization` (string,null)
    Contact's organization.
    Example: "Rebilly"

  - `_embedded.invoice.billingAddress.address` (string,null)
    First line of the contact's street address.
    Example: "36 Craven St"

  - `_embedded.invoice.billingAddress.address2` (string,null)
    Second line of the contact's street address.

  - `_embedded.invoice.billingAddress.city` (string,null)
    Contact's city of residence.
    Example: "Austin"

  - `_embedded.invoice.billingAddress.region` (string,null)
    Contact's region of residence.
    Example: "Texas"

  - `_embedded.invoice.billingAddress.country` (string,null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: "GB"

  - `_embedded.invoice.billingAddress.postalCode` (string,null)
    Contact's postal code.
    Example: "WC2N 5NF"

  - `_embedded.invoice.billingAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `_embedded.invoice.billingAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: "main"

  - `_embedded.invoice.billingAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: "1-512-777-0269"

  - `_embedded.invoice.billingAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `_embedded.invoice.billingAddress.emails` (array)
    List of email addresses associated with the contact.

  - `_embedded.invoice.billingAddress.emails.label` (string, required)
    Email label or name.
    Example: "main"

  - `_embedded.invoice.billingAddress.emails.value` (string, required)
    Email address value.
    Example: "rebilly@example.com"

  - `_embedded.invoice.billingAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `_embedded.invoice.billingAddress.dob` (string,null)
    Contact's date of birth in ISO-8601 YYYY-MM-DD format.
    Example: "1980-04-01"

  - `_embedded.invoice.billingAddress.jobTitle` (string,null)
    Contact's job title.
    Example: "CEO"

  - `_embedded.invoice.deliveryAddress` (object)
    Delivery address of the invoice.

  - `_embedded.invoice.poNumber` (string,null)
    Purchase order number that is displayed on the invoice.
    Example: "PO123456"

  - `_embedded.invoice.notes` (string)
    Notes for the customer that are displayed on the invoice.

  - `_embedded.invoice.autopayScheduledTime` (string,null)
    Date and time when an automatic payment (autopay) is scheduled.

  - `_embedded.invoice.dueTime` (string)
    Date and time when the invoice is due for payment.

  - `_embedded.invoice.customerId` (string, required)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `_embedded.invoice.retryInstruction` (object,null)
    Invoice payment retry instruction.
This object specifies how to proceed if a payment related to the invoice fails.

  - `_embedded.invoice.retryInstruction.attempts` (array, required)
    Describes the retry instruction.

  - `_embedded.invoice.retryInstruction.attempts.scheduleInstruction` (object, required) — one of (discriminator: method):
    Specifies when the payment retry instruction is performed.
    - date-interval:
      - `method` (string, required)
        Enum: "date-interval"
      - `duration` (integer, required)
        Number of time units.
      - `unit` (any, required)
        Unit of time.
      - `anchor` (object) — one of (discriminator: method):
        Instruction for calculating the period anchor.
        - day-of-month:
          - `method` (string, required)
            Enum: "day-of-month"
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-of-week:
          - `method` (string, required)
            Enum: "day-of-week"
          - `day` (string, required)
            Day of the week when the event occurs.
            Enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"
          - `week` (string, required)
            Enum: "next", "first-in-month", "last-in-month"
          - `time` (string)
            Extended ISO-8601 format of time.
    - day-of-month:
      - `method` (string, required)
        Enum: same as `method` in "day-of-month" (1 values)
      - `day` (integer, required)
        Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
      - `time` (string)
        Extended ISO-8601 format of time.
    - day-of-week:
      - `method` (string, required)
        Enum: same as `method` in "day-of-week" (1 values)
      - `day` (string, required)
        Day of the week when the event occurs.
        Enum: same as `day` in "day-of-week" (7 values)
      - `week` (string, required)
        Enum: same as `week` in "day-of-week" (3 values)
      - `time` (string)
        Extended ISO-8601 format of time.
    - immediately:
      - `method` (string, required)
        Enum: "immediately"
    - intelligent:
      - `method` (string, required)
        Enum: "intelligent"
      - `duration` (integer, required)
        Latest point in time at which the event should occur.
The event occurs at a random time between the initial time and duration time.
      - `unit` (any, required)
        Unit of time.

  - `_embedded.invoice.retryInstruction.attempts.amountAdjustmentInstruction` (object) — one of (discriminator: method):
    Specifies if the payment amount must be adjusted for the retry.
    - partial:
      - `method` (string, required)
        Enum: "partial"
      - `value` (number, required)
        Amount of the payment.
      - `type` (string, required)
        Payment amount type.
        Enum: "percent", "fixed"
      - `afterApprovalPolicy` (any) — one of (discriminator: method):
        After an approved payment retry for an adjusted amount, this field specifies whether to discount the remaining invoice amount.
        - none:
          - `method` (string, required)
            No payment amount adjustment.
            Enum: "none"
        - discount-amount-remaining:
          - `method` (string, required)
            Discount the remaining amount on the invoice.
            Enum: "discount-amount-remaining"
    - none:
      - `method` (string, required)
        Enum: same as `method` in "none" (1 values)

  - `_embedded.invoice.retryInstruction.attempts.tryBackupInstruments` (boolean)
    Specifies whether to use backup payment instruments on an invoice payment retry.

  - `_embedded.invoice.retryInstruction.afterAttemptPolicies` (array, required)
    Describes the action to take when a payment attempt concludes, and payment is not collected.
    Enum: "change-subscription-renewal-time"

  - `_embedded.invoice.retryInstruction.afterRetryEndPolicies` (array, required)
    Describes the action to take when all scheduled payment retries, in a retry instruction, have concluded and payment is not collected.
    Enum: "abandon-invoice", "cancel-subscription"

  - `_embedded.invoice.delinquencyTime` (string,null)
    Date and time when the related order is considered delinquent, and is canceled.
If this value is null, no delinquency time is configured.
If the dueTime of the order becomes greater than the delinquencyTime value,
the delinquencyTime value becomes equal to dueTime.

If an invoice is not related to an order, this field can only be null.

  - `_links` (array)
    Links to related resources.

  - `_links.href` (string)
    URL of the link.

  - `_links.rel` (string)
    Relationship type of the link.
    Enum: "invoice"


## Response 2xx fields