Attaching Products

Attaching a product to a customer will apply the product items to that customer. This means:

• The customer will get access to the features in the product
• If the product has prices, the customer will be billed for them accordingly

If the product being enabled has prices, a checkout URL or an invoice will be generated for the customer to make payments.

​

With the API

Call attach from your application with:

• a customer_id (your internal user ID)
• the Autumn product_id (defined when the product was created).

You can redirect the customer to the checkout_url returned to complete the payment.

curl --request POST \
  --url https://api.useautumn.com/v1/attach \
  --header 'Authorization: Bearer am_sk_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "john-123",
  "product_id": "pro-tier"
}'

{
  "checkout_url": "https://checkout.stripe.com/....."
}

​

From the UI

1. Go to the Autumn customers page
2. Navigate to the customer you want to enable the product for
3. Click “Attach product”, and choose the product you want to enable for this customer
4. Optionally, make any changes to the product items before enabling it. This will create a custom version of the product.
5. Choose how the customer should pay for the product:
   • Checkout URL: this will only last 1 day before it expires (a limitation of Stripe)
   • Invoice: this is a long lasting payment link. You’ll be taken to the Stripe invoice page where you can check over the invoice, add an email if necessary, and send it

​

Upgrades and downgrades

If you enable a product to a customer with an existing product (with the same attach method), Autumn will handle upgrades and downgrades between different pricing tiers.

​

Upgrades

Upgrades happen when a new product, with a more expensive price than the existing product, is enabled for a customer.

The upgraded product will be immediately enabled and the prices will be switched:

Priced features will depend on the usage reset behavior:

• If usage resets with billing (eg, credits), the outstanding usage will be billed at the existing price immediately. The new price will be applied to usage going forward and applied to the next invoice.
• If there’s no reset (eg, seats), the difference in price is prorated and charged immediately.

Fixed prices will also be prorated and charged immediately. They’ll be charged the difference between the old and the new price, adjusted by the amount of time remaining in the current period.

​

Downgrades

Downgrades happen when a new product, with a cheaper price than the existing product, is enabled for a customer.

Downgrades do not happen immediately. Instead, the new product will be scheduled to start at the end of the current period.

A customer can cancel the scheduled downgrade by attaching the existing product again.

​

Usage reset behaviour

When new products are enabled, you can choose what happens to existing feature usage using the reset_usage_when_enabled property.

• true: existing usage is reset to 0 (typically used for consumable features like credits)
• false: existing usage is carried over to the new product (typically used for continuous features like seats)

​

Product statuses

Customer’s products can be in one of the following statuses: