The Financing offer object Preview

Attributes

• idstring

  A unique identifier for the financing object.

• objectstring

  The object type: financing_offer.

• accepted_termsnullable object

  Information about the current financing object. Describes currency, advance amount, fee amount, withhold rate, and fee discount of previous financing.

  Hide child attributes

  • accepted_terms.advance_amountinteger

    Amount of financing offered, in minor units.

  • accepted_terms.currencystring

    Currency that the financing offer is transacted in. For example, usd.

  • accepted_terms.fee_amountinteger

    Fixed fee amount, in minor units.

  • accepted_terms.previous_financing_fee_discount_amountnullable integer

    Populated when the product_type of the financingoffer is refill. Represents the discount amount on remaining premium for the existing loan at payout time.

  • accepted_terms.withhold_ratefloat

    Per-transaction rate at which Stripe will withhold funds to repay the financing.

• accountstring

  The ID of the merchant associated with this financing object.

• charged_off_atnullable timestamp

  The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.

• createdinteger

  Time at which the offer was created. Given in seconds since unix epoch.

• expires_afterfloat

  Time at which the offer expires. Given in seconds since unix epoch.

• financing_typenullable enum

  The type of financing being offered.

  Possible enum values

  cash_advance Capital’s Merchant Cash Advance program. Has been replaced by flex_loan.

  flex_loan Capital’s standard loan offering. See the integration guide for more information.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• metadatanullable object

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• offered_termsnullable object

  Information about the financing offer. Describes currency, offered advance amount, offered fee amount, campaign type, withhold rate, and fee discount rate of previous financing.

  Hide child attributes

  • offered_terms.advance_amountinteger

    Amount of financing offered, in minor units.

  • offered_terms.campaign_typeenum

    Describes the type of user the offer is being extended to.

    Possible enum values

    newly_eligible_user A user who has never been eligible for Capital before.

    previously_eligible_user A user who has been offered financing through Capital before, but never accepted an offer.

    repeat_user A user who has already accepted or fully repaid a loan, and is receiving another offer.

  • offered_terms.currencystring

    Currency that the financing offer is transacted in. For example, usd.

  • offered_terms.fee_amountinteger

    Fixed fee amount, in minor units.

  • offered_terms.previous_financing_fee_discount_ratenullable float

    Populated when the product_type of the financingoffer is refill. Represents the discount rate percentage on remaining fee on the existing loan. When the financing_offer is paid out, the previous_financing_fee_discount_amount will be computed as the multiple of this rate and the remaining fee.

  • offered_terms.withhold_ratefloat

    Per-transaction rate at which Stripe will withhold funds to repay the financing.

• product_typenullable enum

  Financing product identifier.

  Possible enum values

  refill A “refill” financing offer extended through Stripe Capital. Refills are a form of discounted refinancing. See the integration guide for more information.

  standard A standard financing offer extended through Stripe Capital.

• replacementnullable string

  The ID of the financing offer that replaced this offer.

• replacement_fornullable string

  The ID of the financing offer that this offer is a replacement for.

• statusenum

  The current status of the offer.

  Possible enum values

  accepted Set once an offer has been accepted by the Connected account.

  canceled Set when the Connected account has reached out to Capital’s servicing team within 48 hours of acceptance and requested cancellation of their offer.

  completed Set when the financing offer has fully repaid. This status is no longer in use. See fully_repaid instead.

  delivered Once an offer has been delivered, mark it so using the mark_delivered endpoint.

  expired Set when the financing offer has expired, usually 30 days after creation.

  fully_repaid Set when the financing offer has been fully repaid.

  paid_out Set once an offer has been paid out to the Connected account.

  rejected Set when Capital’s servicing team has rejected the application for financing. The Connected account receives an email with the reason for rejection.

  replaced Set when the financing offer has been replaced.

  undelivered All offers begin in this state. A financing offer must be delivered to its Connected account using approved marketing materials.

• typenullable enumDeprecated

  See financing_type.

  Possible enum values

  cash_advance

  flex_loan