SubscriptionResponseDto

  • allowed_rails
    Type: array of "crypto" or "fiat" or "balance"enum
    required
  • amount
    Type: number
    required
  • canceled_at
    Type: object | null
    required
  • created_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • currency
    Type: string
    required
  • customer_email
    Type: object | null
    required

    Where invoices are sent.

  • customer_id
    Type: object | null
    required

    Who is billed.

  • cycles
    Type: object | null
    required
  • cycles_billed
    Type: number
    required
  • description
    Type: object | null
    required
  • due_days
    Type: number
    required
  • id
    Type: string
    required
  • interval
    Type: stringenum
    required
    values
    weeklymonthlyquarterlyyearly
  • metadata
    Type: object | null
    required
  • next_invoice_at
    Type: object | null
    required

    When the next invoice goes out. Null once nothing is owed.

  • reference
    Type: string
    required
  • start_at
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • status
    Type: stringenum
    required

    past_due means an invoice went unpaid past its grace. It keeps billing and recovers by itself the moment the customer pays.

    values
    activepast_duepausedcanceledcompleted
  • title
    Type: object | null
    required
Previous
CreateSubscriptionDto
Next
TypedApiResponseDto_SubscriptionResponseDto