CustomerBillingConfiguration.md

LagoAPI::CustomerBillingConfiguration

Properties

Name	Type	Description	Notes
invoice_grace_period	Integer	The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items	[optional]
payment_provider	String	The payment provider utilized to initiate payments for invoices issued by Lago. Accepted values: `stripe`, `adyen`, `gocardless` or null. This field is required if you intend to assign a `provider_customer_id`.	[optional]
provider_customer_id	String	The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer	[optional]
sync	Boolean	Set this field to `true` if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the `provider_customer_id` is `null` and the customer is automatically created in the payment provider through Lago. By default, the value is set to `false`	[optional]
sync_with_provider	Boolean	Set this field to `true` if you want to create a customer record in the payment provider's system. This option is applicable only when the `provider_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false`	[optional]
document_locale	String	The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago	[optional]
provider_payment_methods	Array<String>	Specifies the available payment methods that can be used for this customer when `payment_provider` is set to `stripe`. The `provider_payment_methods` field is an array that allows multiple payment options to be defined. If this field is not explicitly set, all the payment methods are selected. For now, possible values are `card` and `sepa_debit`.	[optional]

Example

require 'lago_ruby'

instance = LagoAPI::CustomerBillingConfiguration.new(
  invoice_grace_period: 3,
  payment_provider: stripe,
  provider_customer_id: cus_12345,
  sync: true,
  sync_with_provider: true,
  document_locale: fr,
  provider_payment_methods: ["card","sepa_debit"]
)