Order API

Type

SubscriptionLine1

A current product line on a subscription.

Kind Type
Used in UpdateSubscriptions1

Properties

  • id string optional

    Stable primary line ID assigned by the subscription system.

  • ecomm_id string optional

    Distinct line ID assigned by a separate ecommerce system.

  • product ObjectIdentity1 optional

    Product identity.

  • product_variant ObjectIdentity1 optional

    Product variant identity.

  • selling_plan ObjectIdentity1 optional

    Selling-plan identity.

  • group ObjectIdentity1 optional

    Subscription group or membership-plan identity.

  • quantity integer optional

    Current quantity.

  • unit_price monetary optional

    Regular price per unit.

  • discounted_unit_price monetary optional

    Current price per unit after discounts.

  • subtotal_price monetary optional

    Current subtotal for the line.

  • currency string optional

    ISO 4217 currency code for line amounts.

  • one_time boolean optional

    Whether this line is a one-time addition rather than a recurring item.

Previous
SubscriptionCycle1