Overview
/
Developer Tools
/
API Reference
/
Factory
/
Accept your organization's current Factory quote and charge its default card. Requires organization membership.

Accept your organization's current Factory quote and charge its default card. Requires organization membership

Billing: No usage charge

Path parameters

  • /{job_id}

    stringUUID
    //
  • /{quote_id}

    stringUUID
    //

Query string parameters

  • ?payment_attempt_id=

    UUID
    //
  • &use_credits=

    boolean
    //
  • &max_amount_due_cents=

    int64
    //

Response

  • 200 OK
    • //
      • :

        {{ ... },
        //
        • amount_due:

          numberUSD Price,
          //
        • amount_paid:

          numberUSD Price,
          //
        • amount_refunded:

          numberUSD Price,
          //
        • amount_remaining:

          numberUSD Price,
          //
        • attempt_count:

          numberuint64,
          //
        • attempted:

          boolean,
          //
        • billing_reason:

          string,
          //
        • can_retry_payment:

          boolean,
          //
        • collection_method:

          string,
          //
        • created_at:

          stringISO-8601,
          //
        • currency:

          string,
          //
        • customer_email:

          stringEmail Address,
          //
        • customer_id:

          string,
          //
        • default_payment_method:

          string,
          //
        • description:

          string,
          //
        • id:

          string,
          //
        • number:

          string,
          //
        • boolean,
          //
        • pdf:

          stringURL,
          //
        • receipt_number:

          string,
          //
        • statement_descriptor:

          string,
          //
        • subscription_id:

          string,
          //
        • subtotal:

          numberUSD Price,
          //
        • tax:

          numberUSD Price,
          //
        • total:

          numberUSD Price,
          //
        • url:

          stringURL,
          //
        • :

          [[ ... ],
          //
          • //
            {
            • :

              {{ ... }
              //
              • amount_off:

                numberUSD Price,
                //
              • id:

                string,
                //
              • name:

                string,
                //
              • percent_off:

                numberdouble,
                //
              • :

                {{ ... }
                //
                • [key]:

                  string
                }
              }
            }
          ]
        • :

          [[ ... ],
          //
          • //
            • amount:

              numberUSD Price,
              //
            • currency:

              string,
              //
            • description:

              string,
              //
            • id:

              string,
              //
            • invoice_item:

              string,
              //
            • :

              {{ ... }
              //
              • [key]:

                string
              }
            }
          ]
        • :

          {{ ... },
          //
          • [key]:

            string
          }
        • refund_status:

          "partially_refunded"+1â–¾
          • //Some, but not all, captured funds tied to the invoice were refunded.
            "partially_refunded"
          • //All captured funds tied to the invoice were refunded.
            "refunded"
          ,
          //
        • status:

          "draft"+5â–¾
          • //Draft.
            "draft"
          • //Open.
            "open"
          • //Paid.
            "paid"
          • //Uncollectible.
            "uncollectible"
          • //Void.
            "void"
          • //Unknown.
            "unknown"
          //
        }
      • :

        {{ ... }
        //
        • created_at:

          stringISO-8601,
          //
        • current_version_id:

          stringUUID,
          //
        • id:

          stringUUID,
          //
        • status:

          string,
          //
        • updated_at:

          stringISO-8601
          //
        }
      }

Examples

post
/org/factory/jobs/{job_id}/quotes/{quote_id}/accept
200 OK
Response