UPupfort
Subscriptions

Create subscription

Creates a new Upfort Home subscription for the authenticated partner.

This endpoint is keyed by permanent_id, not email. If email is present, Upfort may use it for communications or account linking, but it is not required and is not the deduplication key.

sku_code is resolved through Upfort's partner configuration and maps to the appropriate internal subscription template or product configuration.

post/partner/subscriptions

Request

  • Base URL
    https://api.consumer.upfort.com/api
  • Auth
    API key in header X-API-Key

Request body

permanent_idstring required

Partner's stable identifier for the subscriber, policy, or membership record.

group_idstring

Partner-defined subgroup identifier for attribution, reporting, and partner-side account grouping.

sku_codestring required

Partner SKU alias or configured canonical Home SKU.

auto_renewboolean

Optional partner preference for whether the subscription should renew automatically. Final behavior may depend on partner configuration.

first_namestring required

Subscriber's first name.

last_namestring required

Subscriber's last name.

emailstring email

Subscriber's email address, when available. Not required and not used as the lifecycle key.

zip_codestring

5-digit US zip code.

start_datestring date required

Subscription effective start date in YYYY-MM-DD format.

phonestring

Subscriber's phone number, when available.

address_line_1string

Subscriber street address, when available.

address_line_2string

Additional address details, when available.

unitstring

Apartment, unit, suite, or similar address designator.

citystring

Subscriber city, when available.

statestring

Two-letter US state code, when available.

countrystring

ISO 3166-1 alpha-2 country code. Defaults to US when omitted.

Response

Subscription created.

successtrue required
timestampstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.