# List subscriptions by organization GET https://api-sandbox.payabli.com/api/Query/subscriptions/org/{orgId} Returns a list of subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. Reference: https://docs.payabli.com/developers/api-reference/subscription/get-list-of-subscriptions-for-an-org ## OpenAPI Specification ```yaml openapi: 3.1.1 info: title: Get list of subscriptions for an org version: endpoint_query.ListSubscriptionsOrg paths: /Query/subscriptions/org/{orgId}: get: operationId: list-subscriptions-org summary: Get list of subscriptions for an org description: >- Returns a list of subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. tags: - - subpackage_query parameters: - name: orgId in: path description: The numeric identifier for organization, assigned by Payabli. required: true schema: type: integer - name: exportFormat in: query required: false schema: $ref: '#/components/schemas/type_:ExportFormat' - name: fromRecord in: query description: >- The number of records to skip before starting to collect the result set. required: false schema: type: integer default: 0 - name: limitRecord in: query description: >- Max number of records to return for the query. Use `0` or negative value to return all records. required: false schema: type: integer default: 20 - name: parameters in: query description: >- Collection of field names, conditions, and values used to filter the query. **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.** Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client. For example: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20 should become: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20 See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information. **List of field names accepted:** - `startDate` (gt, ge, lt, le, eq, ne) - `endDate` (gt, ge, lt, le, eq, ne) - `nextDate` (gt, ge, lt, le, eq, ne) - `frequency` (in, nin, ne, eq) - `method` (in, nin, eq, ne) - `totalAmount` (gt, ge, lt, le, eq, ne) - `netAmount` (gt, ge, lt, le, eq, ne) - `feeAmount` (gt, ge, lt, le, eq, ne) - `status` (in, nin, eq, ne) - `untilcancelled` (eq, ne) - `payaccountLastfour` (nct, ct) - `payaccountType` (ne, eq, in, nin) - `payaccountCurrency` (ne, eq, in, nin) - `customerFirstname` (ct, nct, eq, ne) - `customerLastname` (ct, nct, eq, ne) - `customerName` (ct, nct) - `customerId` (eq, ne) - `customerNumber` (ct, nct, eq, ne) - `customerCompanyname` (ct, nct, eq, ne) - `customerAddress` (ct, nct, eq, ne) - `customerCity` (ct, nct, eq, ne) - `customerZip` (ct, nct, eq, ne) - `customerState` (ct, nct, eq, ne) - `customerCountry` (ct, nct, eq, ne) - `customerPhone` (ct, nct, eq, ne) - `customerEmail` (ct, nct, eq, ne) - `customerShippingAddress` (ct, nct, eq, ne) - `customerShippingCity` (ct, nct, eq, ne) - `customerShippingZip` (ct, nct, eq, ne) - `customerShippingState` (ct, nct, eq, ne) - `customerShippingCountry` (ct, nct, eq, ne) - `orgId` (eq) - `paypointId` (ne, eq) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) - `externalPaypointId` (ct, nct, ne, eq) - `subId` (eq, ne) - `orderDescription` (ct, nct) - `cycles` (eq, ne, gt, ge, lt, le) - `leftcycles` (eq, ne, gt, ge, lt, le) - `createdAt` (eq, ne, gt, ge, lt, le) - `updatedOn` (eq, ne, gt, ge, lt, le) - `invoiceNumber` (ct, nct) - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name **List of comparison operators accepted:** - `eq` or empty => equal - `gt` => greater than - `ge` => greater or equal - `lt` => less than - `le` => less or equal - `ne` => not equal - `ct` => contains - `nct` => not contains - `in` => inside array - `nin` => not inside array required: false schema: type: object additionalProperties: type: string - name: sortBy in: query description: >- The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. required: false schema: type: string - name: requestToken in: header required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/type_:QuerySubscriptionResponse' '400': description: Bad request/ invalid data content: {} '401': description: Unauthorized request. content: {} '500': description: Internal API Error content: {} '503': description: Database connection error content: {} components: schemas: type_:ExportFormat: type: string enum: - description: Comma-separated values file value: csv - description: Excel spreadsheet file value: xlsx type_:CreatedAt: type: string format: date-time type_:BillingZip: type: string type_:Email: type: string format: email type_:CustomerNumberNullable: type: string type_:Shippingaddress: type: string type_:Shippingaddressadditional: type: string type_:Shippingcity: type: string type_:Shippingstate: type: string type_:Shippingzip: type: string type_:Shippingcountry: type: string type_:CustomerId: type: integer format: int64 type_:CustomerStatus: type: integer type_:AdditionalDataMap: type: object additionalProperties: type: string type_:QueryTransactionPayorData: type: object properties: Identifiers: type: array items: description: Any type description: Array of field names to be used as identifiers. FirstName: type: string description: Customer/Payor first name. LastName: type: string description: Customer/Payor last name. CompanyName: type: string description: Customer's company name. BillingAddress1: type: string description: Customer's billing address. BillingAddress2: type: string description: Additional line for Customer's billing address. BillingCity: type: string description: Customer's billing city. BillingState: type: string description: >- Customer's billing state. Must be 2-letter state code for address in US. BillingZip: $ref: '#/components/schemas/type_:BillingZip' description: Customer's billing ZIP code. BillingCountry: type: string description: Customer's billing country. BillingPhone: type: string description: Customer's phone number. BillingEmail: $ref: '#/components/schemas/type_:Email' description: Customer's email address. CustomerNumber: $ref: '#/components/schemas/type_:CustomerNumberNullable' ShippingAddress1: $ref: '#/components/schemas/type_:Shippingaddress' ShippingAddress2: $ref: '#/components/schemas/type_:Shippingaddressadditional' ShippingCity: $ref: '#/components/schemas/type_:Shippingcity' ShippingState: $ref: '#/components/schemas/type_:Shippingstate' ShippingZip: $ref: '#/components/schemas/type_:Shippingzip' ShippingCountry: $ref: '#/components/schemas/type_:Shippingcountry' customerId: $ref: '#/components/schemas/type_:CustomerId' customerStatus: $ref: '#/components/schemas/type_:CustomerStatus' AdditionalData: $ref: '#/components/schemas/type_:AdditionalDataMap' type_:DatetimeNullable: type: string format: date-time type_:EntrypageId: type: integer format: int64 type_:ExternalPaypointId: type: string type_:FileContentFtype: type: string enum: - value: pdf - value: doc - value: docx - value: jpg - value: jpeg - value: png - value: gif - value: txt type_:FileContent: type: object properties: fContent: type: string description: >- Content of file, Base64-encoded. Ignored if furl is specified. Max upload size is 30 MB. filename: type: string description: The name of the attached file. ftype: $ref: '#/components/schemas/type_:FileContentFtype' description: The MIME type of the file (if content is provided) furl: type: string description: Optional URL provided to show or download the file remotely type_:Attachments: type: array items: $ref: '#/components/schemas/type_:FileContent' type_:Discount: type: number format: double type_:DutyAmount: type: number format: double type_:FreightAmount: type: number format: double type_:Frequency: type: string enum: - value: onetime - value: weekly - value: every2weeks - value: every6months - value: monthly - value: every3months - value: annually type_:InvoiceAmount: type: number format: double type_:Datenullable: type: string format: date type_:InvoiceNumber: type: string type_:Invoicestatus: type: integer type_:InvoiceType: type: integer type_:ItemCommodityCode: type: string type_:ItemDescription: type: string type_:ItemProductCode: type: string type_:ItemProductName: type: string type_:ItemUnitofMeasure: type: string type_:BillItem: type: object properties: itemCategories: type: array items: type: string description: Array of tags classifying item or product. itemCommodityCode: $ref: '#/components/schemas/type_:ItemCommodityCode' itemCost: type: number format: double description: Item or product price per unit. itemDescription: $ref: '#/components/schemas/type_:ItemDescription' itemMode: type: integer description: >- Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both. itemProductCode: $ref: '#/components/schemas/type_:ItemProductCode' itemProductName: $ref: '#/components/schemas/type_:ItemProductName' itemQty: type: integer description: Quantity of item or product. itemTaxAmount: type: number format: double description: Tax amount applied to item or product. itemTaxRate: type: number format: double description: Tax rate applied to item or product. itemTotalAmount: type: number format: double description: Total amount in item or product. itemUnitOfMeasure: $ref: '#/components/schemas/type_:ItemUnitofMeasure' required: - itemCost type_:BillDataPaymentTerms: type: string enum: - value: PIA - value: CIA - value: UR - value: NET10 - value: NET20 - value: NET30 - value: NET45 - value: NET60 - value: NET90 - value: EOM - value: MFI - value: 5MFI - value: 10MFI - value: 15MFI - value: 20MFI - value: 2/10NET30 - value: UF - value: 10UF - value: 20UF - value: 25UF - value: 50UF type_:PurchaseOrder: type: string type_:ShippingFromZip: type: string type_:SummaryCommodityCode: type: string type_:Tax: type: number format: double type_:TermsConditions: type: string type_:BillData: type: object properties: AdditionalData: $ref: '#/components/schemas/type_:AdditionalDataMap' attachments: $ref: '#/components/schemas/type_:Attachments' company: type: string description: Company name of the recipient of the invoice. discount: $ref: '#/components/schemas/type_:Discount' dutyAmount: $ref: '#/components/schemas/type_:DutyAmount' firstName: type: string description: First name of the recipient of the invoice. freightAmount: $ref: '#/components/schemas/type_:FreightAmount' frequency: $ref: '#/components/schemas/type_:Frequency' description: Frequency of scheduled invoice. invoiceAmount: $ref: '#/components/schemas/type_:InvoiceAmount' invoiceDate: $ref: '#/components/schemas/type_:Datenullable' description: 'Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.' invoiceDueDate: $ref: '#/components/schemas/type_:Datenullable' description: >- Invoice due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. invoiceEndDate: $ref: '#/components/schemas/type_:Datenullable' description: >- Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. invoiceNumber: $ref: '#/components/schemas/type_:InvoiceNumber' description: Invoice number. Identifies the invoice under a paypoint. invoiceStatus: $ref: '#/components/schemas/type_:Invoicestatus' invoiceType: $ref: '#/components/schemas/type_:InvoiceType' items: type: array items: $ref: '#/components/schemas/type_:BillItem' description: Array of line items included in the invoice. lastName: type: string description: Last name of the recipient of the invoice. notes: type: string description: Notes included in the invoice. paymentTerms: $ref: '#/components/schemas/type_:BillDataPaymentTerms' purchaseOrder: $ref: '#/components/schemas/type_:PurchaseOrder' shippingAddress1: $ref: '#/components/schemas/type_:Shippingaddress' shippingAddress2: $ref: '#/components/schemas/type_:Shippingaddressadditional' shippingCity: $ref: '#/components/schemas/type_:Shippingcity' shippingCountry: $ref: '#/components/schemas/type_:Shippingcountry' shippingEmail: $ref: '#/components/schemas/type_:Email' description: Shipping recipient's contact email address. shippingFromZip: $ref: '#/components/schemas/type_:ShippingFromZip' shippingPhone: type: string description: Recipient phone number. shippingState: $ref: '#/components/schemas/type_:Shippingstate' shippingZip: $ref: '#/components/schemas/type_:Shippingzip' summaryCommodityCode: $ref: '#/components/schemas/type_:SummaryCommodityCode' tax: $ref: '#/components/schemas/type_:Tax' termsConditions: $ref: '#/components/schemas/type_:TermsConditions' type_:LastModified: type: string format: date-time type_:Netamountnullable: type: number format: double type_:OrgParentName: type: string type_:Accountexp: type: string type_:Accountid: type: string type_:Accounttype: type: string type_:Accountzip: type: string type_:BinData: type: object properties: binMatchedLength: type: string description: |- The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table. binCardBrand: type: string description: |- The card brand. For example, Visa, Mastercard, American Express, Discover. binCardType: type: string description: 'The type of card: Credit or Debit.' binCardCategory: type: string description: >- The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. binCardIssuer: type: string description: The name of the financial institution that issued the card. binCardIssuerCountry: type: string description: The issuing financial institution's country name. binCardIssuerCountryCodeA2: type: string description: >- The issuing financial institution's two-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. binCardIssuerCountryNumber: type: string description: >- The issuing financial institution's ISO standard numeric country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. binCardIsRegulated: type: string description: Indicates whether the card is regulated. binCardUseCategory: type: string description: The use category classification for the card. binCardIssuerCountryCodeA3: type: string description: >- The issuing financial institution's three-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. type_:Holdername: type: string type_:Initiator: type: string type_:Maskedaccount: type: string type_:Orderdescription: type: string type_:PaymentCategories: type: object properties: amount: type: number format: double description: Price/cost per unit of item or category. description: type: string description: Description of item or category label: type: string description: Name of item or category. qty: type: integer default: 1 description: Quantity of item or category required: - amount - label type_:SplitFundingContent: type: object properties: accountId: type: string description: The accountId for the account the split should be sent to. amount: type: number format: double description: Amount from the transaction to sent to this recipient. description: type: string description: A description for the split. recipientEntryPoint: type: string description: The entrypoint the split should be sent to. type_:SplitFunding: type: array items: $ref: '#/components/schemas/type_:SplitFundingContent' type_:PaymentDetail: type: object properties: categories: type: array items: $ref: '#/components/schemas/type_:PaymentCategories' description: >- Array of payment categories/line items describing the amount to be paid. **Note**: These categories are for information only and aren't validated against the total amount provided. checkImage: type: object additionalProperties: description: Any type description: Object containing image of paper check. checkNumber: type: string description: >- A check number to be used in the ach transaction. **Required** for payment method = 'check'. currency: type: string description: >- The currency for the transaction, `USD` or `CAD`. If your paypoint is configured for CAD, you must send the `CAD` value in this field, otherwise it defaults to USD, which will cause the transaction to fail. serviceFee: type: number format: double description: >- Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. splitFunding: $ref: '#/components/schemas/type_:SplitFunding' description: >- Split funding instructions for the transaction. See [Split a Transaction](/developers/developer-guides/money-in-split-funding) for more. totalAmount: type: number format: double description: >- Total amount to be charged. If a service fee is sent, then this amount should include the service fee." required: - totalAmount type_:Sequence: type: string type_:Signaturedata: type: string type_:Storedmethodid: type: string type_:StoredMethodUsageType: type: string type_:QueryPaymentData: type: object properties: AccountExp: $ref: '#/components/schemas/type_:Accountexp' accountId: $ref: '#/components/schemas/type_:Accountid' AccountType: $ref: '#/components/schemas/type_:Accounttype' AccountZip: $ref: '#/components/schemas/type_:Accountzip' binData: $ref: '#/components/schemas/type_:BinData' HolderName: $ref: '#/components/schemas/type_:Holdername' Initiator: $ref: '#/components/schemas/type_:Initiator' MaskedAccount: $ref: '#/components/schemas/type_:Maskedaccount' orderDescription: $ref: '#/components/schemas/type_:Orderdescription' paymentDetails: $ref: '#/components/schemas/type_:PaymentDetail' Sequence: $ref: '#/components/schemas/type_:Sequence' SignatureData: $ref: '#/components/schemas/type_:Signaturedata' StoredId: $ref: '#/components/schemas/type_:Storedmethodid' description: Identifier of stored payment method used in transaction. StoredMethodUsageType: $ref: '#/components/schemas/type_:StoredMethodUsageType' type_:Dbaname: type: string type_:Entrypointfield: type: string type_:PaypointId: type: integer format: int64 type_:Legalname: type: string type_:Source: type: string type_:GeneralEvents: type: object properties: description: type: string description: Event description. eventTime: type: string format: date-time description: Event timestamp, in UTC. extraData: type: object additionalProperties: description: Any type description: Extra data. refData: type: string description: Reference data. source: $ref: '#/components/schemas/type_:Source' description: The event source. type_:SubscriptionQueryRecords: type: object properties: CreatedAt: $ref: '#/components/schemas/type_:CreatedAt' description: Timestamp of when the subscription ws created, in UTC. Customer: $ref: '#/components/schemas/type_:QueryTransactionPayorData' EndDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The subscription's end date. EntrypageId: $ref: '#/components/schemas/type_:EntrypageId' ExternalPaypointID: $ref: '#/components/schemas/type_:ExternalPaypointId' FeeAmount: type: number format: double description: Fee applied to the subscription. Frequency: type: string description: The subscription's frequency. IdSub: type: integer format: int64 description: The subscription's ID. InvoiceData: $ref: '#/components/schemas/type_:BillData' LastRun: $ref: '#/components/schemas/type_:DatetimeNullable' description: The last time the subscription was processed. LastUpdated: $ref: '#/components/schemas/type_:LastModified' description: The last date and time the subscription was updated. LeftCycles: type: integer description: The number of cycles the subscription has left. Method: type: string description: The subscription's payment method. NetAmount: $ref: '#/components/schemas/type_:Netamountnullable' description: The subscription amount, minus any fees. NextDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The next date the subscription will be processed. ParentOrgName: $ref: '#/components/schemas/type_:OrgParentName' PaymentData: $ref: '#/components/schemas/type_:QueryPaymentData' PaypointDbaname: $ref: '#/components/schemas/type_:Dbaname' description: The paypoint's DBA name. PaypointEntryname: $ref: '#/components/schemas/type_:Entrypointfield' description: The paypoint's entryname. PaypointId: $ref: '#/components/schemas/type_:PaypointId' PaypointLegalname: $ref: '#/components/schemas/type_:Legalname' description: The paypoint's legal name. PlanId: type: integer description: Payment plan ID. Source: $ref: '#/components/schemas/type_:Source' StartDate: $ref: '#/components/schemas/type_:DatetimeNullable' description: The subscription start date. SubEvents: type: array items: $ref: '#/components/schemas/type_:GeneralEvents' description: Events associated with the subscription. SubStatus: type: integer description: |- The subscription's status. - 0: Paused - 1: Active TotalAmount: type: number format: double description: The subscription amount, including any fees. TotalCycles: type: integer description: The total number of cycles the subscription is set to run. UntilCancelled: type: boolean description: >- When `true`, the subscription has no explicit end date and will run until canceled. type_:PageIdentifier: type: string type_:Pagesize: type: integer type_:Totalrecords: type: integer type_:QuerySummary: type: object properties: pageIdentifier: $ref: '#/components/schemas/type_:PageIdentifier' pageSize: $ref: '#/components/schemas/type_:Pagesize' totalAmount: type: number format: double description: Total amount for the records. totalNetAmount: type: number format: double description: Total net amount for the records. totalPages: $ref: '#/components/schemas/type_:Totalrecords' totalRecords: $ref: '#/components/schemas/type_:Totalrecords' type_:QuerySubscriptionResponse: type: object properties: Records: type: array items: $ref: '#/components/schemas/type_:SubscriptionQueryRecords' Summary: $ref: '#/components/schemas/type_:QuerySummary' ``` ## SDK Code Examples ```python Example from payabli import payabli client = payabli( api_key="YOUR_API_KEY", ) client.query.list_subscriptions_org( org_id=123, from_record=251, limit_record=0, sort_by="desc(field_name)", ) ``` ```typescript Example import { PayabliClient } from "@payabli/sdk-node"; const client = new PayabliClient({ apiKey: "YOUR_API_KEY" }); await client.query.listSubscriptionsOrg(123, { fromRecord: 251, limitRecord: 0, sortBy: "desc(field_name)" }); ``` ```go Example import ( context "context" option "github.com/payabli/sdk-go/option" sdkgo "github.com/payabli/sdk-go" sdkgoclient "github.com/payabli/sdk-go/client" ) client := sdkgoclient.NewClient( option.WithApiKey( "", ), ) response, err := client.Query.ListSubscriptionsOrg( context.TODO(), 123, &sdkgo.ListSubscriptionsOrgRequest{ FromRecord: sdkgo.Int( 251, ), LimitRecord: sdkgo.Int( 0, ), SortBy: sdkgo.String( "desc(field_name)", ), }, ) ``` ```csharp Example using PayabliApi; var client = new PayabliApiClient("API_KEY"); await client.Query.ListSubscriptionsOrgAsync( 123, new ListSubscriptionsOrgRequest { FromRecord = 251, LimitRecord = 0, SortBy = "desc(field_name)", } ); ``` ```ruby Example require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/subscriptions/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java Example HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/subscriptions/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php Example request('GET', 'https://api-sandbox.payabli.com/api/Query/subscriptions/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```swift Example import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/subscriptions/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```