Integrate with Invoicing

Use our official libraries for access to the Stripe API from your application:

# Available as a gem
sudo gem install stripe

# If you use bundler, you can add this line to your Gemfile
gem 'stripe'

The Customer object represents the customer purchasing your product and is required for creating an invoice.

curl https://api.stripe.com/v1/customers \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "name"="jenny rosen" \
  -d "email"="jenny.rosen@example.com" \
  -d "description"="My First Test Customer (created for API docs)"

This returns a Customer object:

{
  "id": "cus_GBV60HKsE0mb5v",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1621071891,
  "currency": "usd",
  "default_source": null,
  "delinquent": false,
  "description": "My First Test Customer (created for API docs)",

After creating the customer, store the id value in your database so you can use it later. For example, the next step uses the customer ID to create an invoice.

To create an invoice, pass the customer ID and a price:

# Using the customer ID returned in step 2
curl https://api.stripe.com/v1/invoiceitems \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "customer"="cus_4fdAW5ftNQow1a" \
  -d "price"="price_CBb6IXqvTLXp3f"
curl https://api.stripe.com/v1/invoices \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "customer"="cus_4fdAW5ftNQow1a" \
  -d "auto_advance"="true"

To simplify the example, auto_advance is set to true. This means Stripe automatically finalizes the invoice after a few hours, making the invoice ready for payment. Emails aren’t sent in test mode but you can verify that the invoice was created by checking the Invoices section of the Dashboard. The invoice has a Scheduled status until it’s automatically finalized.

If you set auto_advance to false, you can continue to modify the invoice until you finalize it. You can finalize a draft invoice using the Dashboard by sending it to the customer or paying it. You can also use the finalize API:

curl https://api.stripe.com/v1/invoices/:id/finalize \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -X "POST"