# Invoice paid

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

## Request fields

- `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).
  Example: web_0YV7DE4Z26DQSA1AC92FBJ7SEG
- `_embedded.invoice.currency` (string, required)
  Currency code in ISO 4217 format.
  Example: USD
- `_embedded.invoice.shipping` (object)
  Shipping settings.
- `_embedded.invoice.tax` (object)
  Taxes.
- `_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: "eu-vat", "other"
- `_embedded.invoice.customerTaxIdNumber.value` (string, required)
  Value of the tax ID number.
  Example: GB980780684
- `_embedded.invoice.billingAddress` (object)
  Contact's information.
- `_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.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)
  Specifies when the payment retry instruction is performed.
- `_embedded.invoice.retryInstruction.attempts.amountAdjustmentInstruction` (object)
  Specifies if the payment amount must be adjusted for the retry.
- `_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.
- `_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.
- `_embedded.invoice.organizationId` (string)
  Unique organization identifier. An organization is an entity that represents a company. For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
  Example: org_0YVDM8RC7GDADADSBSMW124JA8
- `_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. When the invoice `dueTime` is changed to a later date and time, `delinquencyTime` increases by the same amount. If `dueTime` is changed to an earlier date and time or `delinquencyTime` is `null`, `delinquencyTime` remains unchanged. Changing `dueTime` to an earlier date and time increases the gap between `dueTime` and `delinquencyTime`. This wider gap is preserved if `dueTime` subsequently changes to a later date and time. If the request also specifies `delinquencyTime`, the specified value takes precedence. If `delinquencyTime` is earlier than the invoice `dueTime`, it is set to the same value as `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"
