Record

subscription

No description available.

record subscription {
  application: option​<string>,
  application-fee-percent: option​<f64>,
  automatic-tax: subscription-automatic-tax,
  billing-cycle-anchor: s32,
  billing-thresholds: option​<string>,
  cancel-at: option​<s32>,
  cancel-at-period-end: bool,
  canceled-at: option​<s32>,
  cancellation-details: option​<string>,
  collection-method: get-subscriptions-collection-method-enum,
  created: s32,
  currency: string,
  current-period-end: s32,
  current-period-start: s32,
  customer: string,
  days-until-due: option​<s32>,
  default-payment-method: option​<string>,
  default-source: option​<string>,
  default-tax-rates: option​<list​<tax-rate>>,
  description: option​<string>,
  discount: option​<string>,
  ended-at: option​<s32>,
  id: string,
  items: subscription-items,
  latest-invoice: option​<string>,
  livemode: bool,
  metadata: subscription-metadata,
  next-pending-invoice-item-invoice: option​<s32>,
  object: subscription-object-enum,
  on-behalf-of: option​<string>,
  pause-collection: option​<string>,
  payment-settings: option​<string>,
  pending-invoice-item-interval: option​<string>,
  pending-setup-intent: option​<string>,
  pending-update: option​<string>,
  schedule: option​<string>,
  start-date: s32,
  status: subscription-status-enum,
  test-clock: option​<string>,
  transfer-data: option​<string>,
  trial-end: option​<s32>,
  trial-settings: option​<string>,
  trial-start: option​<s32>,
}

Fields

NameTypeDescription
applicationoption​<string>
application-fee-percentoption​<f64>
automatic-taxsubscription-automatic-tax
billing-cycle-anchors32
billing-thresholdsoption​<string>
cancel-atoption​<s32>
cancel-at-period-endbool
canceled-atoption​<s32>
cancellation-detailsoption​<string>
collection-methodget-subscriptions-collection-method-enum
createds32
currencystring
current-period-ends32
current-period-starts32
customerstring
days-until-dueoption​<s32>
default-payment-methodoption​<string>
default-sourceoption​<string>
default-tax-ratesoption​<list​<tax-rate>>
descriptionoption​<string>
discountoption​<string>
ended-atoption​<s32>
idstring
itemssubscription-items
latest-invoiceoption​<string>
livemodebool
metadatasubscription-metadata
next-pending-invoice-item-invoiceoption​<s32>
objectsubscription-object-enum
on-behalf-ofoption​<string>
pause-collectionoption​<string>
payment-settingsoption​<string>
pending-invoice-item-intervaloption​<string>
pending-setup-intentoption​<string>
pending-updateoption​<string>
scheduleoption​<string>
start-dates32
statussubscription-status-enum
test-clockoption​<string>
transfer-dataoption​<string>
trial-endoption​<s32>
trial-settingsoption​<string>
trial-startoption​<s32>