Skip to main content

GetGroupPaymentsList​

Returns a list of payments for the given group.

Path Parameters
  • group_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

Query Parameters
  • start_payment_id string

    The payment ID of the payment after which to start listing.

Responses

GetGroupPaymentsList 200 response

Schema
  • payments object[] required

    A list of a group's billing payments.

    • amount int64 required

      Payment amount (in hundreths USD, 100 = $1.00).

    • description string

      A description of this payment.

    • from_invoice boolean required

      Whether or not this payment is from an invoice.

    • created_ts date-time required

      RFC3339 timestamp.

    • status string required

      Possible values: [succeeded, processing, refunded]

      A value denoting the status of a billing transfer.

  • end_payment_id string

    The ID of the last payment listed.