payment_provider_id
, and setting payment_provider
to stripe_invoice
. Note that the payment provider here is stripe_invoice
. If you instead pass stripe_charge
, we will use Stripe as a payment gateway, and not as an invoicing provider.
The customer’s Stripe ID can be found on the customer page, and starts with the prefix cus_
.
Once mappings are configured, invoices for customers with a Stripe payment provider ID will be synced to Stripe Invoicing. For synced invoices, payment methods and invoice display are controlled with Stripe’s platform settings.
Metadata Field | Description |
---|---|
payment_source | Always set to orb to identify invoices synced from Orb |
orb_invoice_id | The Orb invoice ID for cross-referencing |
orb_subscription_id | The Orb subscription ID, or empty if this is not a subscription invoice (e.g., one-off invoice) |
orb_customer_id | The Orb customer ID |
orb_external_plan_id | The Orb external plan ID, or empty if it does not exist |
orb_external_customer_id | The Orb external customer ID, or empty if the customer does not have an external customer ID |
customer.updated
webhook from Stripe, the system will automatically sync any address changes to the linked Orb customer. This ensures that address information remains consistent between both platforms without manual intervention.charge_automatically
: Stripe will attempt to automatically charge the customer’s default payment method upon invoice finalization.send_invoice
: Stripe will send the invoice to the customer without immediately charging a card.due_date
of the invoice.
collection_behavior
is set tocharge_automatically
collection_behavior
is set to send_invoice
due date
is set to null
to accomodate limitations in Stripeauto_advance
field determines whether the invoice should be automatically finalized after it’s created. Orb sets this true
.