Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Subjects

Upsert subject

Upserts a subject. Creates or updates subject.

If the subject doesn't exist, it will be created. If the subject exists, it will be partially updated with the provided fields.

⚠️ Deprecated: Subjects as managable entities are being depracated, use customers with subject key usage attribution instead.

post/api/v1/subjects

Request body

keystring required

A unique, human-readable identifier for the subject. This is typically a database ID or a customer key.

displayNamestring nullable

A human-readable display name for the subject.

metadataobject nullable

Metadata for the subject.

currentPeriodStartstring date-time

The start of the current period for the subject.

currentPeriodEndstring date-time

The end of the current period for the subject.

stripeCustomerIdstring nullable

The Stripe customer ID for the subject.

Example request

[
  {
    "key": "customer-id",
    "displayName": "Customer Name",
    "metadata": {
      "hubspotId": "123456"
    },
    "stripeCustomerId": "cus_JMOlctsKV8"
  }
]

Response

The request has succeeded.

createdAtstring date-time required

Timestamp of when the resource was created.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

idstring required

A unique identifier for the subject.

keystring required

A unique, human-readable identifier for the subject. This is typically a database ID or a customer key.

displayNamestring nullable

A human-readable display name for the subject.

metadataobject nullable

Metadata for the subject.

currentPeriodStartstring date-time

The start of the current period for the subject.

currentPeriodEndstring date-time

The end of the current period for the subject.

stripeCustomerIdstring nullable

The Stripe customer ID for the subject.

Example response

[
  {
    "createdAt": "2025-01-01T01:01:01.001Z",
    "updatedAt": "2025-02-01T01:01:01.001Z",
    "deletedAt": "2025-03-01T01:01:01.001Z",
    "id": "01G65Z755AFWAKHE12NY0CQ9FH",
    "key": "customer-id",
    "displayName": "Customer Name",
    "metadata": {
      "hubspotId": "123456"
    },
    "stripeCustomerId": "cus_JMOlctsKV8"
  }
]