--- title: "all subscriptions" method: GET path: "/users/{uuid}/subscriptions" tags: ["Users"] --- # all subscriptions `GET /users/{uuid}/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.one('users', '{uuid}').get('subscriptions', params = {}, headers = {}) => Promise<{result}>` :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper ## Path parameters - `uuid` string, required ## Query parameters - `private` boolean - `q` string - `limit` number - `offset` number - `sort` string - `order` 'asc' | 'desc' - `mode` string - `status` string - `source` string - `userUuid` string - `designation` string - `campaign` string - `organisation` string - `profile` string - `user` string - `includeLastDonation` boolean ## Headers - `Authorization` string ## Response `200` The resulting collection of Subscription records - object - `data` MemberSubscription[] - `amount` integer, required — `public` The amount (in cents) of the subscription - `anchorDays` integer[] — `public` Required when `interval` is `SEMI_MONTH`. Two distinct days of month on which the subscription charges each calendar month. Stored normalized to sorted ascending order. Days that do not exist in a given month (e.g. `31` in February) are clamped to the last day of that month. - `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 - `designationUuid` string — `public` UUID of the assigned designation - `email` 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` 'WEEK' | 'MONTH' | 'YEAR' | 'SEMI_MONTH', required — `public` The interval of the subscriptions. See `count`. `SEMI_MONTH` requires `anchorDays` to be provided and charges on two per-month anchor days. - `isExpress` boolean — `public` Indicates whether this donation was made via a Raisely-hosted express payment flow. `false` for `OFFLINE` subscriptions. - `items` object[] — `public` The donation items associated with this donation - `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` 'CHECKED_IN' | 'VALID' — `public` Whether the donation item (ticket) has been checked in - `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. - `parentBundleItem` string — `public` The item ID / reference of this ticket's parent bundle - `parentBundleItemDescription` string — `public` The ticket's parent bundle description - `perkUuid` string — `public` Deprecated - `private` object — `public` - `productUuid` string — `public` The uuid for the associated product or ticket. - `public` object — `public` - `quantity` integer — `public` If multiple of the item, the number of items claimed - `status` 'ISSUED' | 'CANCELLED' — `public` The status of the donation item - `type` 'DONATION' | 'REGISTRATION' | 'OTHER' | 'TICKET' | 'DISCOUNT' — `public` The item type. For most manual API calls, you should use the value `OTHER`. - `updatedAt` string — `public` ISO8601 created timestamp - `uuid` string — `public` Unique identifier for the item - `itemTypes` string[] — `public` One or more of DONATION, REGISTRATION, TICKET or OTHER - `lastName` string, required — `public` The last name of the person - `message` string — `public` A public message left by the donor - `method` 'CREDIT_CARD' | 'CUSTOM' | 'STRIPE_INTENT' | 'PAYPAL', required — `public` The payment gateway used for the subscription. Use STRIPE_INTENT for new subscriptions. - `methodType` string — `public` The type of payment method used, to distinguish between card, direct debit and digital wallet payments. - `mode` 'LIVE' | 'TEST' — `public` LIVE or TEST. Will default to the current mode of the campaign - `nextPayment` string — `public` An ISO8601 timestamp of the next payment due date. Raisely will charge the donation after this date. - `pausedAt` string — `public` Timestamp when the subscription was paused - `paypalSubscriptionId` string — `public` PayPal subscription ID for tracking PayPal recurring donations - `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 - `profile` NestedProfileWithUser - `activityTotal` integer — `public` The total contribution of this profile towards its activity goal - `activityTotalPercent` integer — `public` The percentage of the total activity measure compared to the profile goal (out of 100) - `campaignDisplayTotal` integer — `public` The total amount raised by a profile (in the currency of the campaign) - `createdAt` string — `public` Date the record was created - `currency` string — `public` 3 letter currency code - `description` string — `public` Public description of the fundraiser profile - `donationCount` integer — `public` Total donations made to this profile and it's children. (excluded matched gifts) - `donationRecordCount` integer — `public` Every donation record on this profile regardless of status or mode (same scope as permanent-delete validation, broader than donationCount). - `exerciseGoal` integer — `public` The exercise distance goal for the profile, in metres - `exerciseGoalTime` integer — `public` The time spent exercising goal for the profile, in minutes - `exerciseTotal` integer — `public` The total distance of exercise completed, in metres - `exerciseTotalTime` integer — `public` The total amount of time exercising, in minutes - `facebookFundraiserId` string — `public` Facebook Fundraiser ID linked to the profile - `fundraiserTheme` string — `public` Path of the DIY fundraiser theme selected by the fundraiser - `goal` integer — `public` Fundraising target (in cents) - `individualProfileCount` integer — `public` Number of individual profiles that have joined this profile (or it's descendants) - `isCampaignProfile` boolean — `public` Shows true if this profile is the campaign profile - `name` string — `public` The name of the profile - `nonSelfDonationTotal` integer — `public` The total amount raised by a profile excluding self-donations (in the currency of the campaign) - `organisationProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `paid` boolean — `public` Flagged as true if this profile was used as part of a paid registration - `path` string — `public` The path of this record (for alternative lookup) - `photoUrl` string — `public` URL of the profile photo - `private` object — `public` Private values for this record - `pronouns` string — `public` Pronouns of the profile - `public` object — `public` Public values for this record - `selfDonationTotal` integer — `public` The total amount raised by self-donations for an individual profile (in the currency of the campaign) - `shared` boolean — `public` Flag that determines if a profile has been shared by its owner - `status` 'ACTIVE' | 'DELETED' | 'PURGED' — `public` ACTIVE, DELETED, or PURGED - `subscriptionCount` integer — `public` Subscriptions associated with this profile (same scope as permanent-delete validation). - `teamProfileCount` integer — `public` Number of team profiles that have joined this profile (or it's descendants) - `type` 'INDIVIDUAL' | 'GROUP' | 'ORGANISATION' — `public` INDIVIDUAL, GROUP or ORGANISATION - `uniqueDonors` integer — `public` Total unique donors to the profile - `updatedAt` string — `public` Date the record was last updated - `uuid` string — `public` Unique identifier for the record - `user` NestedUser - `accessToken` string — `public` A secret token for this user, used to authenticate them against the API or in your campaign. - `address1` string — `public` Line 1 of an address - `address2` string — `public` Line 2 of an address - `adminSettings` object — `public` Object containing settings for admin users - `v4BetaOptin` boolean — `public` Whether admin has opted into v4 - `starredCampaigns` string[] — `public` Array of favourite campaigns for user - `country` string — `public` The country of the user - `createdAt` string — `public` Date the record was created - `email` string — `public` The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. - `facebookId` string — `public` The Facebook ID provided on authentication - `firstName` string — `public` The first name of the user - `fullName` string — `public` The full name of the user - `internal` object — `public` Internal values related to this record - `ipCity` string — `public` Deprecated - `ipCountry` string — `public` Deprecated - `ipLatitude` number — `public` Deprecated - `ipLongitude` number — `public` Deprecated - `ipNumber` string — `public` Deprecated - `isAdmin` boolean — `public` Will be true if this user has admin permissions - `isSamlLogin` boolean — `public` Will be true if this user logs in via organisation SAML login - `language` string — `public` The language the user last interacted in - `lastName` string — `public` The last name of the user - `permission` string — `public` Deprecated. Use roles - `phoneNumber` string — `public` Phone number of the user - `photoUrl` string — `public` URL of the user's photo - `postcode` string — `public` Postal code of the user - `preferredName` string — `public` The name that the user prefers to be called - `private` object — `public` Private values for this record - `public` object — `public` Public values for this record - `state` string — `public` The state/province of the user - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — `public` ACTIVE, DELETED, or PENDING - `suburb` string — `public` The suburb/city of the user - `swiftAidAuthExpiry` string — `public` Date of expiry of donor authorisation for SwiftAid - `swiftAidDonorId` string — `public` Id of donor on SwiftAid - `unsubscribedAt` string — `public` ISO8601 timestamp of when the user was unsubscribed from non-essential emails or sms. A blank value indicates the user is still subscribed. - `updatedAt` string — `public` Date the record was last updated - `username` string — `public` The login email for this user - `uuid` string — `public` Unique identifier for the record - `userUuid` string — The uuid of the associated user - `profileUuid` string, required — `public` Unique identifier for the record - `public` object — `public` Public values for this record - `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` 'OFFLINE' | 'ONLINE' — `public` The source of this subscription. Subscriptions created through the API should have a source of `OFFLINE`. - `status` 'OK' | 'RETRYING' | 'FAILING' | 'FAILED' | 'PAUSED' | 'DELETED' | 'CANCELLED' | 'PENDING' — `public` Status of the subscription - `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` NestedUser - `accessToken` string — `public` A secret token for this user, used to authenticate them against the API or in your campaign. - `address1` string — `public` Line 1 of an address - `address2` string — `public` Line 2 of an address - `adminSettings` object — `public` Object containing settings for admin users - `v4BetaOptin` boolean — `public` Whether admin has opted into v4 - `starredCampaigns` string[] — `public` Array of favourite campaigns for user - `country` string — `public` The country of the user - `createdAt` string — `public` Date the record was created - `email` string — `public` The user's email address. Raisely uses this as a unique identifier and will deduplicate on email. - `facebookId` string — `public` The Facebook ID provided on authentication - `firstName` string — `public` The first name of the user - `fullName` string — `public` The full name of the user - `internal` object — `public` Internal values related to this record - `ipCity` string — `public` Deprecated - `ipCountry` string — `public` Deprecated - `ipLatitude` number — `public` Deprecated - `ipLongitude` number — `public` Deprecated - `ipNumber` string — `public` Deprecated - `isAdmin` boolean — `public` Will be true if this user has admin permissions - `isSamlLogin` boolean — `public` Will be true if this user logs in via organisation SAML login - `language` string — `public` The language the user last interacted in - `lastName` string — `public` The last name of the user - `permission` string — `public` Deprecated. Use roles - `phoneNumber` string — `public` Phone number of the user - `photoUrl` string — `public` URL of the user's photo - `postcode` string — `public` Postal code of the user - `preferredName` string — `public` The name that the user prefers to be called - `private` object — `public` Private values for this record - `public` object — `public` Public values for this record - `state` string — `public` The state/province of the user - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — `public` ACTIVE, DELETED, or PENDING - `suburb` string — `public` The suburb/city of the user - `swiftAidAuthExpiry` string — `public` Date of expiry of donor authorisation for SwiftAid - `swiftAidDonorId` string — `public` Id of donor on SwiftAid - `unsubscribedAt` string — `public` ISO8601 timestamp of when the user was unsubscribed from non-essential emails or sms. A blank value indicates the user is still subscribed. - `updatedAt` string — `public` Date the record was last updated - `username` string — `public` The login email for this user - `uuid` string — `public` Unique identifier for the record - `userUuid` string — `public` Unique identifier for the record - `uuid` string — `public` Unique identifier for the record - `pagination` Pagination - `total` integer — The total amount of records returned - `pages` integer — The amount of pages (by limit) returned - `prevUrl` union — Url that points to the previous set of records in the pagination if available - string - boolean - `nextUrl` union — Url that points to the next set of records in the pagination if available - string - boolean - `offset` integer — The total number of records to offset in the pagination - `limit` integer — The maximum amount of records to shown in each page ## Other responses - `401` — Authorization credentials were missing or invalid - `403` — The user is authenticated, but is not allowed to perform the requested operation - `404` — One of the records needed to complete the request could not be found - `410` — The requested record no longer exists, or that API has been deprecated - `429` — You have made too many requests to the given endpoint, please try again later - `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com --- [API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)