Update Entity

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.entities.update({
  customerId: "cus_123",
  entityId: "seat_42",
  billingControls: {
    spendLimits: [
      {
        featureId: "messages",
        enabled: true,
        limitType: "usage_percentage",
        overageLimit: 120,
      },
    ],
  },
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.entities.update(
    entity_id="seat_42",
    customer_id="cus_123",
    billing_controls={
        "spend_limits": [
            {
                "feature_id": "messages",
                "enabled": True,
                "limit_type": "usage_percentage",
                "overage_limit": 120,
            },
        ],
    },
)

curl --request POST \
  --url https://api.useautumn.com/v1/entities.update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "entity_id": "seat_42",
  "billing_controls": {
    "spend_limits": [
      {
        "feature_id": "messages",
        "enabled": true,
        "limit_type": "usage_percentage",
        "overage_limit": 120
      }
    ]
  }
}
'

{
  "id": "seat_42",
  "name": "Seat 42",
  "customer_id": "cus_123",
  "feature_id": "seats",
  "created_at": 1771409161016,
  "env": "sandbox",
  "subscriptions": [
    {
      "plan_id": "pro_plan",
      "auto_enable": true,
      "add_on": false,
      "status": "active",
      "past_due": false,
      "canceled_at": null,
      "expires_at": null,
      "trial_ends_at": null,
      "started_at": 1771431921437,
      "current_period_start": 1771431921437,
      "current_period_end": 1771999921437,
      "quantity": 1
    }
  ],
  "purchases": [],
  "balances": {
    "messages": {
      "feature_id": "messages",
      "granted": 100,
      "remaining": 72,
      "usage": 28,
      "unlimited": false,
      "overage_allowed": false,
      "max_purchase": null,
      "next_reset_at": 1773851121437,
      "breakdown": [
        {
          "id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
          "plan_id": "pro_plan",
          "included_grant": 100,
          "prepaid_grant": 0,
          "remaining": 72,
          "usage": 28,
          "unlimited": false,
          "reset": {
            "interval": "month",
            "resets_at": 1773851121437
          },
          "price": null,
          "expires_at": null
        }
      ]
    }
  },
  "invoices": []
}

POST

entities.update

Typescript (SDK)

import { Autumn } from 'autumn-js'

const autumn = new Autumn()

const result = await autumn.entities.update({
  customerId: "cus_123",
  entityId: "seat_42",
  billingControls: {
    spendLimits: [
      {
        featureId: "messages",
        enabled: true,
        limitType: "usage_percentage",
        overageLimit: 120,
      },
    ],
  },
});

from autumn_sdk import Autumn

autumn = Autumn(secret_key="am_sk_test...")

res = autumn.entities.update(
    entity_id="seat_42",
    customer_id="cus_123",
    billing_controls={
        "spend_limits": [
            {
                "feature_id": "messages",
                "enabled": True,
                "limit_type": "usage_percentage",
                "overage_limit": 120,
            },
        ],
    },
)

curl --request POST \
  --url https://api.useautumn.com/v1/entities.update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "customer_id": "cus_123",
  "entity_id": "seat_42",
  "billing_controls": {
    "spend_limits": [
      {
        "feature_id": "messages",
        "enabled": true,
        "limit_type": "usage_percentage",
        "overage_limit": 120
      }
    ]
  }
}
'

{
  "id": "seat_42",
  "name": "Seat 42",
  "customer_id": "cus_123",
  "feature_id": "seats",
  "created_at": 1771409161016,
  "env": "sandbox",
  "subscriptions": [
    {
      "plan_id": "pro_plan",
      "auto_enable": true,
      "add_on": false,
      "status": "active",
      "past_due": false,
      "canceled_at": null,
      "expires_at": null,
      "trial_ends_at": null,
      "started_at": 1771431921437,
      "current_period_start": 1771431921437,
      "current_period_end": 1771999921437,
      "quantity": 1
    }
  ],
  "purchases": [],
  "balances": {
    "messages": {
      "feature_id": "messages",
      "granted": 100,
      "remaining": 72,
      "usage": 28,
      "unlimited": false,
      "overage_allowed": false,
      "max_purchase": null,
      "next_reset_at": 1773851121437,
      "breakdown": [
        {
          "id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
          "plan_id": "pro_plan",
          "included_grant": 100,
          "prepaid_grant": 0,
          "remaining": 72,
          "usage": 28,
          "unlimited": false,
          "reset": {
            "interval": "month",
            "resets_at": 1773851121437
          },
          "price": null,
          "expires_at": null
        }
      ]
    }
  },
  "invoices": []
}

Body Parameters

Response

{
  "id": "seat_42",
  "name": "Seat 42",
  "customer_id": "cus_123",
  "feature_id": "seats",
  "created_at": 1771409161016,
  "env": "sandbox",
  "subscriptions": [
    {
      "plan_id": "pro_plan",
      "auto_enable": true,
      "add_on": false,
      "status": "active",
      "past_due": false,
      "canceled_at": null,
      "expires_at": null,
      "trial_ends_at": null,
      "started_at": 1771431921437,
      "current_period_start": 1771431921437,
      "current_period_end": 1771999921437,
      "quantity": 1
    }
  ],
  "purchases": [],
  "balances": {
    "messages": {
      "feature_id": "messages",
      "granted": 100,
      "remaining": 72,
      "usage": 28,
      "unlimited": false,
      "overage_allowed": false,
      "max_purchase": null,
      "next_reset_at": 1773851121437,
      "breakdown": [
        {
          "id": "cus_ent_39qmLooixXLAqMywgXywjAz96rV",
          "plan_id": "pro_plan",
          "included_grant": 100,
          "prepaid_grant": 0,
          "remaining": 72,
          "usage": 28,
          "unlimited": false,
          "reset": {
            "interval": "month",
            "resets_at": 1773851121437
          },
          "price": null,
          "expires_at": null
        }
      ]
    }
  },
  "invoices": []
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-version

string

default:2.3.0

required

Body

application/json

entity_id

string

required

The ID of the entity.

customer_id

string

The ID of the customer that owns the entity.

billing_controls

object

Billing controls to replace on the entity.

Show child attributes

Response

200 - application/json

string | null

required

The unique identifier of the entity

name

string | null

required

The name of the entity

created_at

number

required

Unix timestamp when the entity was created

env

enum<string>

required

The environment (sandbox/live)

Available options:

sandbox,

live

subscriptions

object[]

required

Show child attributes

purchases

object[]

required

Show child attributes

balances

object

required

Show child attributes

flags

object

required

Show child attributes

customer_id

string | null

The customer ID this entity belongs to

feature_id

string | null

The feature ID this entity belongs to

billing_controls

object

Billing controls for the entity.

Show child attributes

invoices

object[]

Invoices for this entity (only included when expand=invoices)

Show child attributes

Create Entity Delete Entity

⌘I

Billing

Balances

Customers

Authorization

Events

Entities

Plans

Features

Rewards & Referrals

Webhook Events

Platform (Beta)

Body Parameters

Response

Authorizations

Headers

Body

Response

​Body Parameters

​Response

Authorizations

Headers

Body

Response

Body Parameters

Response