Recurly

https://docs.recurly.com/
Admin
Recurly is a subscription management platform that helps businesses automate billing, manage...
Tokens:1,104,300
Snippets:11,699
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### One-time, Subscribe & Save, Prepaid - Example: Product configuration with mixed selling plan types

Source: https://docs.recurly.com/recurly-commerce/reference/getting-started-with-prive-widget-api

Shows the beginning of a product configuration that includes one-time, subscribe & save, and prepaid options. The example is truncated in the source, showing only the product ID, hasVariantLevel flag, and the start of a selling plan group with requires_selling_plan set to false.

```JSX
{
    "productId": "gid://shopify/Product/7604549058805",
    "hasVariantLevel": false,
    "selling_plan_groups": [
        {
            "requires_selling_plan": false,
            "id": "gid://shopify/SellingPlanGroup/633340149",
```

--------------------------------

### New Setup with Elements (HTML)

Source: https://docs.recurly.com/recurly-subscriptions/docs/upgrading

HTML markup for the new Elements setup, using a div with class my-card-element.

```html
<div class="my-card-element"></div>
```

--------------------------------

### Install packages with npm

Source: https://docs.recurly.com/recurly-engage/docs/react-native

Install the core and React Native packages using npm.

```shell
npm install @recurly/redfast-core
npm install @recurly/react-native-redfast
```

--------------------------------

### PHP: Get total record count using Pager.count

Source: https://docs.recurly.com/recurly-subscriptions/docs/pagination-guide

Uses the `count` method of the `Pager` to get the total number of records without fetching the entire result set. The example lists accounts with a limit of 200, sorted by updated_at ascending, and fetches the first account.

```PHP
$beginTime = new DateTime("2020-01-01 00:00:00");
$accounts = $client->listAccounts([
    'limit' => 200,
    'sort' => 'updated_at',
    'order' => 'asc',
    'begin_time' => $beginTime
]);
$account = $accounts->getFirst();

print("First Account updated since {$beginTime->format('Y-m-d')}: {$account->getCode()}");
```

--------------------------------

### Initialize SDK with PromptProvider and check initialization with usePrompt

Source: https://docs.recurly.com/recurly-engage/docs/react-native-sdk-v2

This snippet shows the full initialization flow: wrapping the app root with PromptProvider, using usePrompt to access promptMgr, polling isInitialized() to set readiness, and rendering PromptOverlay. It also includes an optional font loading example using useFonts and dispatching font actions.

```JavaScript
// Initialize the SDK at the top of your app node
export default function App() {
  return (
    <PromptProvider appId="YOUR_APP_ID" userId="INITIAL_USER_ID">
      <AppRoot />
    </PromptProvider>
  );
}

// pull the SDK to check it has been initialized
const AppRoot: React.FC = () => {
  const {
    dispatch,
    state: { promptMgr },
  } = usePrompt();
  const [isReady, setReady] = React.useState(false);

  React.useEffect(() => {
    if (!promptMgr) return;
    const intervalId = setInterval(() => {
      if (promptMgr.isInitialized()) {
        setReady(true);
        clearInterval(intervalId);
      }
    }, 1000);
    return () => clearInterval(intervalId);
  }, [promptMgr]); // eslint-disable-line react-hooks/exhaustive-deps

  return (
    <NavigationContainer>
      {isReady && (
        <Stack.Navigator screenOptions={{ headerShown: true }}>
          <Stack.Screen />
          <Stack.Screen />
          ...
        </Stack.Navigator>
      )}
      <PromptOverlay
        onEvent={(result: PromptResult) => {
          // TODO: handle the result
        }}
      />
    </NavigationContainer>
  );
}

// (optional) You can load the SDK with specific fonts for various parts of the prompts
const AppRoot: React.FC = () => {
  ...
  useFonts({
    buttonFont: require('../assets/fonts/AllProDisplayC-Bold.ttf'),
    otherFont: require('../assets/fonts/AllProDisplayC-Regular.ttf'),
  });

  React.useEffect(() => {
    if (!promptMgr) return;
    const intervalId = setInterval(() => {
      if (promptMgr.isInitialized()) {
        dispatch({
          type: PromptAction_Font_Button,
          data: 'buttonFont',
        });
        dispatch({
          type: PromptAction_Font_Timer,
          data: 'otherFont',
        });
        dispatch({
          type: PromptAction_Font_LegalText,
          data: 'otherFont',
        });
        setReady(true);
        clearInterval(intervalId);
      }
    }, 1000);
    return () => clearInterval(intervalId);
  }, [promptMgr]); // eslint-disable-line react-hooks/exhaustive-deps

  ...
}
```

--------------------------------

### Java: Get total record count using Pager.count

Source: https://docs.recurly.com/recurly-subscriptions/docs/pagination-guide

Uses the `count` method of the `Pager` to get the total number of records without fetching the entire result set. The example lists accounts with a limit of 200, sorted by updated_at ascending, and fetches the first account.

```Java
DateTime beginTime = new DateTime(2020, 1, 1, 0, 0);

QueryParams params = new QueryParams();
params.setLimit(200);
params.setSort("updated_at");
params.setOrder("asc");
params.setBeginTime(beginTime);
Pager<Account> accounts = client.listAccounts(params);
Account account = accounts.getFirst();

System.out.println("First Account updated since " + beginTime + ": " + account.getCode());
```

--------------------------------

### Minimal latency implementation example with preconnect and preload

Source: https://docs.recurly.com/recurly-engage/docs/javascript-sdk

Replace YOUR_TAG_URL with your specific Recurly Engage script URL. This HTML example shows the recommended placement of resource hints and the synchronous script tag in the head for fastest execution.

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!-- 1. Resource Hints (preconnect and preload) -->
    <link rel="preconnect" href="YOUR_TAG_URL">
    <link rel="preload" href="YOUR_TAG_URL/redfast.js" as="script">
    <!-- Other meta tags and stylesheets here -->
    <!-- 2. Synchronous Recurly Engage Script (placed high in <head>) -->
    <script src="YOUR_TAG_URL/redfast.js"></script>

    <title>Your Website Title</title>
</head>
<body>
    <!-- Page Content -->
</body>
</html>
```

--------------------------------

### Ruby: Get total record count using Pager.count

Source: https://docs.recurly.com/recurly-subscriptions/docs/pagination-guide

Uses the `count` method of the `Pager` to get the total number of records without fetching the entire result set. The example lists accounts with a limit of 200, sorted by updated_at ascending, and fetches the first account.

```Ruby
begin_time = DateTime.new(2020, 1, 1)
accounts = @client.list_accounts(
    limit: 200,
    sort: 'updated_at',
    order: 'asc',
    begin_time: begin_time
)
account = accounts.first

puts "First Account updated since #{begin_time}: #{account.code}"
```

--------------------------------

### New Setup with Elements (JavaScript)

Source: https://docs.recurly.com/recurly-subscriptions/docs/upgrading

JavaScript configuration for Elements: configure with public key, create Elements instance, create CardElement with style, and attach to the element.

```javascript
recurly.configure('my-public-key');

const elements = recurly.Elements();
const card = elements.CardElement({
  style: {
    inputType: 'mobileSelect',
    fontColor: '#010101'
  }
});
card.attach('.my-card-element');
```

--------------------------------

### C#: Get total record count using Pager.count

Source: https://docs.recurly.com/recurly-subscriptions/docs/pagination-guide

Uses the `count` method of the `Pager` to get the total number of records without fetching the entire result set. The example lists accounts with a limit of 200, sorted by updated_at ascending, and fetches the first account.

```C#
var beginTime = new DateTime(2020, 1, 1);
var accounts = client.ListAccounts(
    limit: 200,
    sort: "updated_at",
    order: "asc",
    beginTime: beginTime
);
var account = accounts.First();

Console.WriteLine($"First Account updated since {beginTime}: {account.Code}");
```

--------------------------------

### Pre-populate name and email with first_name, last_name, email parameters

Source: https://docs.recurly.com/recurly-subscriptions/docs/hosted-payment-pages

Use `first_name`, `last_name`, and `email` parameters to pre-fill the sign-up form. The second example shows including an account code with the name and email.

```url
https://example.recurly.com/subscribe/:plan_code?first_name=Verena&last_name=Example&email=verena%40example.com
```

```url
https://:your_subdomain.recurly.com/subscribe/:plan_code?account_code=:account_code&first_name=Verena&last_name=Example&email=verena%40example.com
```

--------------------------------

### JavaScript: Get total record count using Pager.count

Source: https://docs.recurly.com/recurly-subscriptions/docs/pagination-guide

Uses the `count` method of the `Pager` to get the total number of records without fetching the entire result set. The example lists accounts with a limit of 200, sorted by updated_at ascending, and fetches the first account.

```JavaScript
const beginTime = new Date('January 1, 2020')
const accounts = await client.listAccounts({
    limit: 200,
    sort: 'updated_at',
    order: 'asc',
    beginTime: beginTime
})
const account = await accounts.first()

console.log(`First Account updated since ${beginTime}: ${account.code}`)
```

--------------------------------

### Initialize Recurly Engage SDK in BrightScript

Source: https://docs.recurly.com/recurly-engage/docs/roku-sdk

Initializes the SDK in the main scene BrightScript file. Includes optional font setup, obtaining the SDK version, observing the result field, and calling initPromotion with required appId and optional userId, annonymousUserId, ctaFont, and timeoutFont. Also includes an onInitialized callback that appends the first screen to the scene stack.

```brightscript
sub init()
  ' other app initialization code here

  ' optionally specify cta-button and timer countdown fonts
  ctaF = CreateObject("roSGNode", "Font")
  ctaF.uri = "pkg:/fonts/Roboto-Regular.ttf"
  ctaF.size = 16
  timeoutF = CreateObject("roSGNode", "Font")
  timeoutF.uri = "pkg:/fonts/Roboto-Regular.ttf"
  timeoutF.size = 16

  m.promoMgr = m.top.GetScene().findNode("promoMgr") ' or m.top.findNode("promoMgr")
  print m.promoMgr.callFunc("getVersion") ' lookup current SDK version
  m.promoMgr.observeField("result", "onInitialized")
  ' appId argument is required, all others are optional
  m.promoMgr.callFunc("initPromotion", {appId: "[YOUR APP ID]", userId: "[USER ID]", annonymousUserId: "[ANON USER ID]", ctaFont: ctaF, timeoutFont: timeoutF})
end sub

sub onInitialized()
  m.promoMgr.unobserveField("result")
  m.sceneStack = m.top.findNode("sceneStack")
  scene = createObject("RoSGNode", "[YOUR FIRST SCREEN OF THE APP]")
  m.sceneStack.appendChild(scene)
end sub
```

--------------------------------

### Line item with custom_fields JSON

Source: https://docs.recurly.com/recurly-subscriptions/docs/custom-fields-legacy-api-content

Example JSON showing a line item with a custom_fields array, as returned in GET calls for Line Items, Purchases, and Invoices.

```json
{
  "line_items": [
    {
      "currency": "USD",
      "unit_amount": "1.05",
      "type": "charge",
      "quantity": 1,
      "custom_fields": [
        {
          "name": "Foo",
          "value": "bar"
        }
      ]
    }
  ]
}
```

--------------------------------

### Initialize Engage with PromotionManager.initPromotion

Source: https://docs.recurly.com/recurly-engage/docs/android-sdk

Add this line in your app's main activity or application file. Replace [appID] with your app ID from Settings > Application in Pulse, and [userID] with the current user's ID.

```Kotlin
PromotionManager.initPromotion([appID], [userID])
```

--------------------------------

### GET /ping

Source: https://docs.recurly.com/recurly-engage/reference/ping-api

The ping call is the starting point to interacting with the Redfast backend. It should be invoked periodically to load the prompts appropriate for the current user. The response object indicates when (in seconds) the next invocation should take place in order to retrieve updated prompts.

```APIDOC
## GET /ping

### Description
The ping call is the starting point to interacting with the Redfast backend. It should be invoked periodically to load the prompts appropriate for the current user. The response object indicates when (in seconds) the next invocation should take place in order to retrieve updated prompts.

### Method
GET

### Endpoint
https://conduit.redfast.com/ping

### Parameters
#### Query Parameters
- **id** (string) - Optional - App ID - this may be used instead of the `rf-app` authorization header
- **device_type** (string) - Optional - Defaults to web. Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.

#### Headers
- **user-id** (string) - Optional - Defaults to test-user. Unique identifier for the unauthenticated user
- **anonymous-user-id** (string) - Optional - Defaults to anon-123. Unique authenticated identifier for the user

### Response
#### Success Response (200)
- **response** (object) - The response object indicates when (in seconds) the next invocation should take place in order to retrieve updated prompts.

#### Response Example
{
  "next_invocation_seconds": 60
}
```
Tokens:
Raw