get all

get https://api.raisely.com/v3/subscriptions

Returns a list of subscriptions you've previously created. The subscriptions will be returned in descending order of when they were created, unless you specify otherwise.

For custom components:

RaiselyComponents.api.all('subscriptions').get(params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

private

boolean

Returns the full record when authenticated

string

Search query to find records matching

limit

number

The number of records to limit per page

offset

number

The pagination offset (in number of records)

sort

string

The record attribute to filter on (use in conjunction with order)

order

string

The direction to sort (only applied if sort is also provided)
asc - Ascending
desc - Descending

mode

string

Filter Subscription based on their mode value

status

string

Filter Subscription based on their status value

userUuid

string

Filter Subscription based on their userUuid value

campaign

string

Filter by campaign path or uuid

organisation

string

Filter by organisation uuid

profile

string

Filter by profile path or uuid

user

string

Filter by user uuid

Headers

Authorization

string

A valid HTTP Bearer token, required to access private records.

Responses

Response body

object

data

array of objects

data

object

amount

integer

required

public The amount (in cents) of the subscription

anonymous

boolean

public True if the person's name should be hidden from donation feeds

campaignUuid

string

required

public Unique identifier for the record

card

string

public The gateway card ID to charge when collecting the subscription

count

integer

required

public The frequency of the subscription, used in conjunction with the interval property. For instance, a monthly subscription would have a count of 1 and an interval of MONTH. A fortnightly subscription would have a count of 2 and an interval of WEEK.

createdAt

string

public Date the record was created

currency

string

required

public ISO alpha-3 letter currency code

customer

string

public The gateway customer ID (only used when importing new subscriptions)

declineCode

string

public The decline code from Stripe associated with the last error message, if applicable

string

required

public The user's email address. Raisely uses this as a unique identifier and will associate the subscription with an existing record if the email matches.

error

string

public Last error message when attempting to charge

failed

integer

public Number of consecutive payment failures when collecting the subscription

failedAt

string

public ISO8601 timestamp of the date last charge failed at

fee

integer

public Amount in cents of the Raisely fee. This is automatically calculated by Raisely.

feeOptIn

boolean

public Will be true if the donor opted-in to the Raisely fee on a Raisely-hosted donation form

firstAttempt

string

public Stores the date the next payment was due to be taken on the first attempt of that cycle

firstName

string

required

public The first name of the person

fullName

string

public The full name of the person

interval

string

required

public The interval of the subscriptions. See count.

WEEK MONTH YEAR

isExpress

boolean

public Indicates whether this donation was made via a Raisely-hosted express payment flow. false for OFFLINE subscriptions.

items

array of objects

public The donation items associated with this donation

items

object

amount

integer

public The amount spent on the item in the currency of the donation

amountRefunded

integer

public The total amount refunded in cents for this line item, in the donation currency.

attendance

string

public Whether the donation item (ticket) has been checked in

CHECKED_IN VALID

bundleItemId

integer

public For products purchased as part of a bundle, this specifies the item id of the bundle itself.

campaignAmount

integer

public The amount spent on the item in the currency of the campaign

createdAt

string

public ISO8601 created timestamp

description

string

public Description of the item

includeInTotals

boolean

public If false, the amount is not included in receipts as part of the total donation

itemId

string

public The item ID / reference

originalAmount

integer

public The total amount of this line item in cents prior to any refunds, in the donation currency. Amount is tax inclusive.

perkUuid

string

public Deprecated

private

object

public

Has additional fields

productUuid

string

public The uuid for the associated product or ticket.

public

object

public

Has additional fields

quantity

integer

public If multiple of the item, the number of items claimed

status

string

public The status of the donation item

ISSUED CANCELLED

type

string

public The item type. For most manual API calls, you should use the value OTHER.

DONATION REGISTRATION OTHER TICKET DISCOUNT

updatedAt

string

public ISO8601 created timestamp

uuid

string

public Unique identifier for the item

itemTypes

array of strings

public One or more of DONATION, REGISTRATION, TICKET or OTHER

itemTypes

lastName

string

required

public The last name of the person

message

string

public A public message left by the donor

method

string

required

public The payment gateway used for the subscription. Use STRIPE_INTENT for new subscriptions.

CREDIT_CARD CUSTOM STRIPE_INTENT

methodType

string

public The type of payment method used, to distinguish between card, direct debit and digital wallet payments.

mode

string

public LIVE or TEST. Will default to the current mode of the campaign

LIVE TEST

nextPayment

string

public An ISO8601 timestamp of the next payment due date. Raisely will charge the donation after this date.

preferredDay

integer

public Stores the preferred day for the subscription to be billed on. If interval is WEEK, it's day of the week. If interval is MONTH, it's the day of the month. If interval is YEAR, it's day of the year.

preferredName

string

public The name that the person prefers to be called

private

object

public Private values for this record

Has additional fields

profile

object

profileUuid

string

required

public Unique identifier for the record

public

object

public Public values for this record

Has additional fields

schedule

string

public The schedule the donation is processed in a readable format. For example "every [subscription.schedule]" would become "every month" or "every 3 months".

setupIntentId

string

public Unique Stripe setup intent id. Set to null when adding offline subscriptions.

source

string

public The source of this subscription. Subscriptions created through the API should have a source of OFFLINE.

OFFLINE ONLINE

status

string

public Status of the subscription

OK RETRYING FAILING FAILED PAUSED DELETED CANCELLED PENDING

token

string

required

public Payment gateway token. Set to null when adding offline subscriptions with card and customer.

total

integer

public Total of the subscription (including fees) charged to the subscription card

treatAsNewSubscription

boolean

public This field is only for importing new subscriptions. When false (default), the first successful charge of the card will result in a subscription.rebilled event. Set to true to change the first event to subscription.succeeded and send the Regular Donation Welcome message on the first payment after import.

updatedAt

string

public Date the record was last updated

user

object

public

userUuid

string

public Unique identifier for the record

uuid

string

public Unique identifier for the record

pagination

object

total

integer

The total amount of records returned

pages

integer

The amount of pages (by limit) returned

prevUrl

Url that points to the previous set of records in the pagination if available

nextUrl

Url that points to the next set of records in the pagination if available

offset

integer

The total number of records to offset in the pagination

limit

integer

The maximum amount of records to shown in each page

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.raisely.com/v3/subscriptions \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The resulting collection of Subscription records

401Authorization credentials were missing or invalid

403The user is authenticated, but is not allowed to perform the requested operation

404One of the records needed to complete the request could not be found

410The requested record no longer exists, or that API has been deprecated

429You have made too many requests to the given endpoint, please try again later

500An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com