Uscreen

App · 25 actions

Run your Uscreen video membership: invite and update customers, grant and revoke access, start and cancel subscriptions, manage groups, read invoices, offers and video views, and publish content.

Actions

ActionWhat it does
Add group memberAdd someone to a group by email, as a member or a manager.
Cancel subscriptionCancel a customer's active subscription.
Create customerAdd a customer to the store.
Create groupCreate a group on a subscription plan, so its members share it, with an optional limit on seats.
Create sign-in linkMake a one-time link that signs a customer straight into the store, with no password (single sign-on).
Delete groupDelete a group.
Get contentGet one video, collection or live event with its release stage, prices, categories, tags and author.
Get customerGet one customer by id or email: name, tags, opt-ins, sign-up source and whether they have an active subscription.
Get customer subscriptionGet a customer's active subscription: plan, price, next billing date, trial and pause.
Get invoiceGet one invoice with its amounts (in cents), discount, taxes, status and the customer's id.
Get total watch timeAdd up the time spent watching, for one customer, one piece of content or both, over the last 12 months or a shorter period.
Grant accessGive a customer access to an offer (a subscription, bundle, rental or free offer) or to a single video or collection, without charging them.
List contentList videos, collections and live events with their release stage, prices, categories and author.
List customer's accessList the offers and content a customer has access to, and how each was granted.
List customersList the store's customers, optionally created or changed in a date range.
List groupsList the store's groups (group subscriptions) with their plan, seats and status.
List invoicesList invoices with their amounts, status and payment provider, optionally created or changed in a date range.
List offersList the store's offers: subscription plans, bundles, rentals and free offers, with prices and checkout links.
List video viewsList who watched what in the last 12 months, for one customer, one piece of content or a period, with watch time and device.
Publish contentPublish a video, collection or live event so members can see it.
Remove group memberRemove someone from a group, by their customer id.
Revoke accessEnd one of a customer's accesses at once, by its id from 'List customer's access' or 'Grant access'.
Start subscriptionPut a customer on a subscription plan, billed by Uscreen from the date given or by you outside Uscreen.
Unpublish contentHide a video, collection or live event from members.
Update customerChange a customer's name, email, password, email opt-ins, custom fields or Stripe customer, and add or remove tags.

Add group member

Add someone to a group by email, as a member or a manager. Someone new to the store becomes a customer.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.
EmailemailtextRequired
The member's email address.
NamenametextRequired
The member's full name.
Roleroletext
Member, or manager, who can manage the group. Defaults to member.One of: member (Member (default)), manager.
Skip automationsskip_automationstrue/false
Turn on so this doesn't start the store's Uscreen automations (such as welcome emails) that it otherwise would.

Outputs

memberobject
The member
Example output
{
  "member": {
    "email": "john.doe@example.com",
    "id": 124,
    "joined_on": 1720186565,
    "name": "John Doe",
    "role": "member"
  }
}

Cancel subscription

Cancel a customer's active subscription. Subscriptions bought in the Apple, Google, Roku or Amazon app stores can't be canceled here.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.

Outputs

canceledtrue/false
False when there was no active subscription
subscriptionobject
The canceled subscription, empty if none
Example output
{
  "canceled": true,
  "subscription": {
    "canceled_at": 1720190000,
    "cover_fees": false,
    "covered_fees": null,
    "created_at": 1720186565,
    "currency": "USD",
    "duration": 30,
    "id": 790,
    "origin": "assigned_from_publisher_api",
    "pauses_at": null,
    "perform_action_at": 1722778565,
    "platform": "web",
    "price": 1500,
    "product_id": 456,
    "product_type": "recurring",
    "resumes_at": null,
    "trial": false,
    "trial_period": 0,
    "with_manual_billing": true
  }
}

Create customer

Add a customer to the store. Uscreen emails them an invite unless told not to; it gives no access until you grant some.

Inputs

NamenametextRequired
The customer's full name.
EmailemailtextRequired
The customer's email address. It must not be in use already.
Passwordpasswordtext
At least 8 characters. Leave empty and Uscreen makes one; the invite email lets them set their own.
Don't send the invite emailskip_invitetrue/false
Turn on to add the customer without Uscreen emailing them an invite.
News and updates emailsopted_in_for_news_and_updatestext
Whether the customer gets news and updates emails. Leave empty for opted in.One of: yes (Opted in), no (Opted out).
Community updates emailsopted_in_for_community_updatestext
Whether the customer gets community updates emails. Leave empty for opted in.One of: yes (Opted in), no (Opted out).
Tagstagslist
Up to 25 tags, lowercase letters, digits and dashes only, such as annual-member.
External IDlegacy_idtext
Your own id for the customer in another system.
Stripe customer IDpayment_user_idtext
The customer's Stripe customer ID, such as cus_QPjOM8A4KUf7H0, to match an existing Stripe customer.
Custom field 1field_1text
The value of the store's custom sign-up field 1, if it has one.
Custom field 2field_2text
The value of the store's custom sign-up field 2, if it has one.
Custom field 3field_3text
The value of the store's custom sign-up field 3, if it has one.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "avatar_url": "",
    "created_at": 1720186565,
    "custom_fields": {},
    "email": "jo@example.com",
    "id": 123,
    "legacy_id": null,
    "name": "Jo Bloggs",
    "opted_in_for_community_updates": true,
    "opted_in_for_news_and_updates": true,
    "origin": "publisher_api",
    "referrer": "",
    "subscribed_topic_ids": [
      12
    ],
    "subscriber": false,
    "tags": [
      "annual-member"
    ],
    "utm_params": {
      "utm_campaign": "",
      "utm_content": "",
      "utm_medium": "",
      "utm_source": "",
      "utm_term": ""
    }
  }
}

Create group

Create a group on a subscription plan, so its members share it, with an optional limit on seats.

Inputs

NamenametextRequired
The group's name.
Billing emailbilling_emailtextRequired
The email address the group is billed to.
Subscription planplan_idtextRequired
The subscription plan. Pick one, or give its offer id.
Seatsnumber_of_seatsnumber
How many members it can have. Leave empty for no limit.At least 1.

Outputs

groupobject
The new group
Example output
{
  "group": {
    "billing_email": "billing@example.org",
    "created_at": 1720186565,
    "id": 2333,
    "name": "Team Subscription",
    "number_of_seats": 15,
    "perform_action_at": 1722778565,
    "plan_id": 74,
    "plan_title": "Monthly",
    "status": "active",
    "updated_at": 1720186565,
    "used_seats": 3
  }
}

Make a one-time link that signs a customer straight into the store, with no password (single sign-on).

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.

Outputs

urltext
The one-time link
Example output
{
  "url": "https://example.uscreen.io/sso?token=abc123"
}

Delete group

Delete a group.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
group_idtext
The group deleted
Example output
{
  "deleted": true,
  "group_id": "2333"
}

Get content

Get one video, collection or live event with its release stage, prices, categories, tags and author.

Inputs

Contentcontent_idtextRequired
The video, collection or live event. Pick one, or give its id from an earlier step.

Outputs

contentobject
The content
Example output
{
  "content": {
    "author": {
      "description": "",
      "id": 10,
      "image": "",
      "permalink": "sam-lee",
      "title": "Sam Lee"
    },
    "categories": [
      {
        "id": 5,
        "legacy_id": null,
        "permalink": "yoga",
        "public": true,
        "title": "Yoga"
      }
    ],
    "content_type": "video",
    "created_at": 1720186565,
    "description": "<p>A gentle start.</p>",
    "downloadable": false,
    "duration": 1800,
    "event_launch_date": null,
    "event_state": null,
    "free": false,
    "id": 247,
    "legacy_id": null,
    "main_poster_url": "",
    "part_of_subscription": true,
    "permalink": "morning-yoga",
    "price_cents": 1500,
    "published_at": 1720186565,
    "release_at": null,
    "release_stage": "published",
    "rental_period": null,
    "rental_price_cents": null,
    "secondary_poster_url": "",
    "short_description": "A gentle start.",
    "square_poster_url": "",
    "tags": [
      "yoga"
    ],
    "title": "Morning yoga",
    "video_count": null
  }
}

Get customer

Get one customer by id or email: name, tags, opt-ins, sign-up source and whether they have an active subscription.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "avatar_url": "",
    "created_at": 1720186565,
    "custom_fields": {},
    "email": "jo@example.com",
    "id": 123,
    "legacy_id": null,
    "name": "Jo Bloggs",
    "opted_in_for_community_updates": true,
    "opted_in_for_news_and_updates": true,
    "origin": "publisher_api",
    "referrer": "",
    "subscribed_topic_ids": [
      12
    ],
    "subscriber": false,
    "tags": [
      "annual-member"
    ],
    "utm_params": {
      "utm_campaign": "",
      "utm_content": "",
      "utm_medium": "",
      "utm_source": "",
      "utm_term": ""
    }
  }
}

Get customer subscription

Get a customer's active subscription: plan, price, next billing date, trial and pause. Says so when they have none.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.

Outputs

has_subscriptiontrue/false
False when the customer has no active subscription
subscriptionobject
The subscription, empty when there is none
Example output
{
  "has_subscription": true,
  "subscription": {
    "canceled_at": null,
    "cover_fees": false,
    "covered_fees": null,
    "created_at": 1720186565,
    "currency": "USD",
    "duration": 30,
    "id": 790,
    "origin": "assigned_from_publisher_api",
    "pauses_at": null,
    "perform_action_at": 1722778565,
    "platform": "web",
    "price": 1500,
    "product_id": 456,
    "product_type": "recurring",
    "resumes_at": null,
    "trial": false,
    "trial_period": 0,
    "with_manual_billing": true
  }
}

Get invoice

Get one invoice with its amounts (in cents), discount, taxes, status and the customer's id.

Inputs

Invoice IDinvoice_idtextRequired
The invoice's id, from 'List invoices' or a trigger.

Outputs

invoiceobject
The invoice
Example output
{
  "invoice": {
    "amount": 1500,
    "coupon": null,
    "created_at": 1720186565,
    "currency": "USD",
    "discount": 0,
    "gift_amount": 0,
    "id": 198,
    "localized_amount": 1500,
    "localized_currency": "USD",
    "localized_discount": 0,
    "localized_gift_amount": 0,
    "localized_original_price": 1500,
    "origin": "stripe",
    "original_price": 1500,
    "paid_at": 1720186565,
    "product_id": 443,
    "product_type": "recurring",
    "status": "paid",
    "taxes": [
      {
        "amount": 128,
        "country_code": "US",
        "description": "",
        "display_name": "Sales Tax",
        "inclusive": false,
        "jurisdiction": "California",
        "percentage": 8.5,
        "state": "CA",
        "tax_type": "sales_tax"
      }
    ],
    "trial": false,
    "updated_at": 1720186565,
    "user_id": 123
  }
}

Get total watch time

Add up the time spent watching, for one customer, one piece of content or both, over the last 12 months or a shorter period.

Inputs

Customercustomertext
Only this customer's views, by id or email address.
Contentcontent_idtext
Only views of this video, collection or live event.
Fromfrom_timedate and time
Start of the period, within the last 12 months. Defaults to 12 months ago.
Toto_timedate and time
End of the period. Defaults to now.

Outputs

hoursnumber
The same, in hours
total_watch_timenumber
Seconds watched
Example output
{
  "hours": 1.5,
  "total_watch_time": 5400
}

Grant access

Give a customer access to an offer (a subscription, bundle, rental or free offer) or to a single video or collection, without charging them.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.
Offerproduct_idtextRequired
The offer to give access to. Pick one, or give its id; for a single video or collection, give the content's id and choose its product type.
Product typeproduct_typetext
What kind of product it is. Leave empty to have it read from the offer.One of: recurring (Subscription), fixed_price (One-time purchase or bundle), rent (Rental), freebie (Free offer), program (Single video or collection).
Access until or next renewalaccess_untildate and time
For a rental, when access ends; for a subscription, its next billing date. Leave empty for Uscreen's own.
Billed outside Uscreenwith_manual_billingtrue/false
Turn on if you charge the customer yourself, so Uscreen never bills them. Leave the date empty then.
Skip automationsskip_automationstrue/false
Turn on so this doesn't start the store's Uscreen automations (such as welcome emails) that it otherwise would.

Outputs

accessobject
The access granted
Example output
{
  "access": {
    "canceled_at": null,
    "created_at": 1720186565,
    "id": 789,
    "origin": "assigned_from_publisher_api",
    "perform_action_at": 1720187272,
    "product_id": 456,
    "product_type": "freebie",
    "with_manual_billing": false
  }
}

List content

List videos, collections and live events with their release stage, prices, categories and author. Gets one page; to see more, run it again with the next page it gives.

Inputs

Typecontent_typetext
Only videos, collections or live events. Leave empty for all.One of: video (Videos), collection (Collections), live_event (Live events).
Fromfrom_timedate and time
Only content created on or after this time.
Toto_timedate and time
Only content created on or before this time.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

contentslist
The content
countnumber
How many on this page
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "contents": [
    {
      "author": {
        "description": "",
        "id": 10,
        "image": "",
        "permalink": "sam-lee",
        "title": "Sam Lee"
      },
      "categories": [
        {
          "id": 5,
          "legacy_id": null,
          "permalink": "yoga",
          "public": true,
          "title": "Yoga"
        }
      ],
      "content_type": "video",
      "created_at": 1720186565,
      "description": "<p>A gentle start.</p>",
      "downloadable": false,
      "duration": 1800,
      "event_launch_date": null,
      "event_state": null,
      "free": false,
      "id": 247,
      "legacy_id": null,
      "main_poster_url": "",
      "part_of_subscription": true,
      "permalink": "morning-yoga",
      "price_cents": 1500,
      "published_at": 1720186565,
      "release_at": null,
      "release_stage": "published",
      "rental_period": null,
      "rental_price_cents": null,
      "secondary_poster_url": "",
      "short_description": "A gentle start.",
      "square_poster_url": "",
      "tags": [
        "yoga"
      ],
      "title": "Morning yoga",
      "video_count": null
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": "1"
}

List customer's access

List the offers and content a customer has access to, and how each was granted. Gets one page; to see more, run it again with the next page it gives.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.
Fromfrom_timedate and time
Only access granted on or after this time.
Toto_timedate and time
Only access granted on or before this time.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

accesseslist
The customer's access
countnumber
How many on this page
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "accesses": [
    {
      "canceled_at": null,
      "created_at": 1720186565,
      "id": 789,
      "origin": "assigned_from_publisher_api",
      "perform_action_at": 1720187272,
      "product_id": 456,
      "product_type": "freebie",
      "with_manual_billing": false
    }
  ],
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": "1"
}

List customers

List the store's customers, optionally created or changed in a date range. Gets one page; to see more, run it again with the next page it gives.

Inputs

Fromfrom_timedate and time
Only customers on or after this time.
Toto_timedate and time
Only customers on or before this time.
Dates comparedate_fieldtext
Whether From and To compare when each was created or last changed. Defaults to when created.One of: created_at (When created (default)), updated_at (When last changed).
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

countnumber
How many on this page
customerslist
The customers
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "count": 1,
  "customers": [
    {
      "avatar_url": "",
      "created_at": 1720186565,
      "custom_fields": {},
      "email": "jo@example.com",
      "id": 123,
      "legacy_id": null,
      "name": "Jo Bloggs",
      "opted_in_for_community_updates": true,
      "opted_in_for_news_and_updates": true,
      "origin": "publisher_api",
      "referrer": "",
      "subscribed_topic_ids": [
        12
      ],
      "subscriber": false,
      "tags": [
        "annual-member"
      ],
      "utm_params": {
        "utm_campaign": "",
        "utm_content": "",
        "utm_medium": "",
        "utm_source": "",
        "utm_term": ""
      }
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": "1"
}

List groups

List the store's groups (group subscriptions) with their plan, seats and status. Gets one page; to see more, run it again with the next page it gives.

Inputs

Fromfrom_timedate and time
Only groups on or after this time.
Toto_timedate and time
Only groups on or before this time.
Dates comparedate_fieldtext
Whether From and To compare when each was created or last changed. Defaults to when created.One of: created_at (When created (default)), updated_at (When last changed).
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

countnumber
How many on this page
groupslist
The groups
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "count": 1,
  "groups": [
    {
      "billing_email": "billing@example.org",
      "created_at": 1720186565,
      "id": 2333,
      "name": "Team Subscription",
      "number_of_seats": 15,
      "perform_action_at": 1722778565,
      "plan_id": 74,
      "plan_title": "Monthly",
      "status": "active",
      "updated_at": 1720186565,
      "used_seats": 3
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": "1"
}

List invoices

List invoices with their amounts, status and payment provider, optionally created or changed in a date range. Gets one page; to see more, run it again with the next page it gives.

Inputs

Fromfrom_timedate and time
Only invoices on or after this time.
Toto_timedate and time
Only invoices on or before this time.
Dates comparedate_fieldtext
Whether From and To compare when each was created or last changed. Defaults to when created.One of: created_at (When created (default)), updated_at (When last changed).
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

countnumber
How many on this page
invoiceslist
The invoices
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "count": 1,
  "invoices": [
    {
      "amount": 1500,
      "coupon": null,
      "created_at": 1720186565,
      "currency": "USD",
      "discount": 0,
      "gift_amount": 0,
      "id": 198,
      "localized_amount": 1500,
      "localized_currency": "USD",
      "localized_discount": 0,
      "localized_gift_amount": 0,
      "localized_original_price": 1500,
      "origin": "stripe",
      "original_price": 1500,
      "paid_at": 1720186565,
      "product_id": 443,
      "product_type": "recurring",
      "status": "paid",
      "taxes": [
        {
          "amount": 128,
          "country_code": "US",
          "description": "",
          "display_name": "Sales Tax",
          "inclusive": false,
          "jurisdiction": "California",
          "percentage": 8.5,
          "state": "CA",
          "tax_type": "sales_tax"
        }
      ],
      "trial": false,
      "updated_at": 1720186565,
      "user_id": 123
    }
  ],
  "next_page": 0,
  "page": 1,
  "total_count": "1"
}

List offers

List the store's offers: subscription plans, bundles, rentals and free offers, with prices and checkout links. Gets one page; to see more, run it again with the next page it gives.

Inputs

Fromfrom_timedate and time
Only offers created on or after this time.
Toto_timedate and time
Only offers created on or before this time.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
offerslist
The offers
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
Example output
{
  "count": 1,
  "next_page": 0,
  "offers": [
    {
      "created_at": 1720186565,
      "description": "Everything, billed monthly.",
      "id": 231,
      "main_image_url": "",
      "price_cents": 1500,
      "price_mode": "fixed",
      "private": false,
      "rental_period": null,
      "rental_price_cents": null,
      "rental_price_mode": null,
      "title": "Monthly",
      "type": "recurring",
      "url": "https://example.uscreen.io/checkout/new?o=231"
    }
  ],
  "page": 1,
  "total_count": "1"
}

List video views

List who watched what in the last 12 months, for one customer, one piece of content or a period, with watch time and device. Gets one page; to see more, run it again with the next page it gives.

Inputs

Customercustomertext
Only this customer's views, by id or email address.
Contentcontent_idtext
Only views of this video, collection or live event.
Fromfrom_timedate and time
Start of the period, within the last 12 months. Defaults to 12 months ago.
Toto_timedate and time
End of the period. Defaults to now.
Page sizeper_pagenumber
How many to return, 1 to 100. Uscreen's default is 10.From 1 to 100.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave.At least 1.

Outputs

countnumber
How many on this page
next_pagenumber
Pass as 'Page' for the next page; 0 on the last one
pagenumber
The page read
total_counttext
How many match in all, as Uscreen counts them
viewslist
The views
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "total_count": "1",
  "views": [
    {
      "author_id": "10",
      "author_name": "Sam Lee",
      "browser": "Chrome",
      "content_id": 247,
      "content_title": "Morning yoga",
      "content_type": "video",
      "country_code": "US",
      "duration": 600,
      "os": "macOS",
      "platform": "web",
      "user_id": 123,
      "user_name": "Jo Bloggs",
      "video_id": 232,
      "view_end": 600,
      "view_start": 0
    }
  ]
}

Publish content

Publish a video, collection or live event so members can see it. For a live event, members can then register, and a start time can be set.

Inputs

Contentcontent_idtextRequired
The video, collection or live event. Pick one, or give its id from an earlier step.
Live event startevent_launch_atdate and time
Live events only: when it starts, in the future. Leave empty for anything else.

Outputs

contentobject
The content
Example output
{
  "content": {
    "author": {
      "description": "",
      "id": 10,
      "image": "",
      "permalink": "sam-lee",
      "title": "Sam Lee"
    },
    "categories": [
      {
        "id": 5,
        "legacy_id": null,
        "permalink": "yoga",
        "public": true,
        "title": "Yoga"
      }
    ],
    "content_type": "video",
    "created_at": 1720186565,
    "description": "<p>A gentle start.</p>",
    "downloadable": false,
    "duration": 1800,
    "event_launch_date": null,
    "event_state": null,
    "free": false,
    "id": 247,
    "legacy_id": null,
    "main_poster_url": "",
    "part_of_subscription": true,
    "permalink": "morning-yoga",
    "price_cents": 1500,
    "published_at": 1720186565,
    "release_at": null,
    "release_stage": "published",
    "rental_period": null,
    "rental_price_cents": null,
    "secondary_poster_url": "",
    "short_description": "A gentle start.",
    "square_poster_url": "",
    "tags": [
      "yoga"
    ],
    "title": "Morning yoga",
    "video_count": null
  }
}

Remove group member

Remove someone from a group, by their customer id.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from an earlier step.
Member IDmember_idtextRequired
The member's customer id, from 'Add group member' or 'Get customer'.

Outputs

group_idtext
The group
member_idtext
The member removed
removedtrue/false
Always true once removed
Example output
{
  "group_id": "2333",
  "member_id": "124",
  "removed": true
}

Revoke access

End one of a customer's accesses at once, by its id from 'List customer's access' or 'Grant access'.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.
Access IDaccess_idtextRequired
The access's id, from 'List customer's access' or 'Grant access'.

Outputs

access_idtext
The access revoked
revokedtrue/false
Always true once revoked
Example output
{
  "access_id": "789",
  "revoked": true
}

Start subscription

Put a customer on a subscription plan, billed by Uscreen from the date given or by you outside Uscreen.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.
Subscription planplan_idtextRequired
The subscription plan. Pick one, or give its offer id.
Next billing datenext_billing_atdate and time
When Uscreen next bills them. Leave empty for the plan's own.
Billed outside Uscreenwith_manual_billingtrue/false
Turn on if you charge the customer yourself, so Uscreen never bills them. Leave the date empty then.
Currencycurrencytext
A three-letter code such as USD, one of the store's currencies. Leave empty for the store's default.
Customer covers feescover_feestrue/false
Turn on to add the payment fees to the price, if the store allows it.
Skip automationsskip_automationstrue/false
Turn on so this doesn't start the store's Uscreen automations (such as welcome emails) that it otherwise would.

Outputs

subscriptionobject
The new subscription
Example output
{
  "subscription": {
    "canceled_at": null,
    "cover_fees": false,
    "covered_fees": null,
    "created_at": 1720186565,
    "currency": "USD",
    "duration": 30,
    "id": 790,
    "origin": "assigned_from_publisher_api",
    "pauses_at": null,
    "perform_action_at": 1722778565,
    "platform": "web",
    "price": 1500,
    "product_id": 456,
    "product_type": "recurring",
    "resumes_at": null,
    "trial": false,
    "trial_period": 0,
    "with_manual_billing": true
  }
}

Unpublish content

Hide a video, collection or live event from members.

Inputs

Contentcontent_idtextRequired
The video, collection or live event. Pick one, or give its id from an earlier step.

Outputs

contentobject
The content
Example output
{
  "content": {
    "author": {
      "description": "",
      "id": 10,
      "image": "",
      "permalink": "sam-lee",
      "title": "Sam Lee"
    },
    "categories": [
      {
        "id": 5,
        "legacy_id": null,
        "permalink": "yoga",
        "public": true,
        "title": "Yoga"
      }
    ],
    "content_type": "video",
    "created_at": 1720186565,
    "description": "<p>A gentle start.</p>",
    "downloadable": false,
    "duration": 1800,
    "event_launch_date": null,
    "event_state": null,
    "free": false,
    "id": 247,
    "legacy_id": null,
    "main_poster_url": "",
    "part_of_subscription": true,
    "permalink": "morning-yoga",
    "price_cents": 1500,
    "published_at": 1720186565,
    "release_at": null,
    "release_stage": "unpublished",
    "rental_period": null,
    "rental_price_cents": null,
    "secondary_poster_url": "",
    "short_description": "A gentle start.",
    "square_poster_url": "",
    "tags": [
      "yoga"
    ],
    "title": "Morning yoga",
    "video_count": null
  }
}

Update customer

Change a customer's name, email, password, email opt-ins, custom fields or Stripe customer, and add or remove tags. Only the fields given change.

Inputs

CustomercustomertextRequired
The customer's Uscreen id or email address.
Namenametext
A new name. Leave empty to keep it.
Emailemailtext
A new email address. Leave empty to keep it.
Passwordpasswordtext
A new password of at least 8 characters. Leave empty to keep it.
News and updates emailsopted_in_for_news_and_updatestext
Whether the customer gets news and updates emails. Leave empty to keep it as is.One of: yes (Opted in), no (Opted out).
Community updates emailsopted_in_for_community_updatestext
Whether the customer gets community updates emails. Leave empty to keep it as is.One of: yes (Opted in), no (Opted out).
Add tagsadd_tagslist
Tags to add; the customer's other tags stay. A new name creates the tag and starts automations that watch for it.
Remove tagsremove_tagslist
Tags to take off the customer; their other tags stay.
Stripe customer IDpayment_user_idtext
A Stripe customer ID to match. Uscreen refuses it while the customer has an active subscription.
Custom field 1field_1text
The value of the store's custom sign-up field 1, if it has one. Leave empty to keep it.
Custom field 2field_2text
The value of the store's custom sign-up field 2, if it has one. Leave empty to keep it.
Custom field 3field_3text
The value of the store's custom sign-up field 3, if it has one. Leave empty to keep it.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "avatar_url": "",
    "created_at": 1720186565,
    "custom_fields": {},
    "email": "jo@example.com",
    "id": 123,
    "legacy_id": null,
    "name": "Jo Bloggs",
    "opted_in_for_community_updates": true,
    "opted_in_for_news_and_updates": true,
    "origin": "publisher_api",
    "referrer": "",
    "subscribed_topic_ids": [
      12
    ],
    "subscriber": false,
    "tags": [
      "annual-member",
      "vip"
    ],
    "utm_params": {
      "utm_campaign": "",
      "utm_content": "",
      "utm_medium": "",
      "utm_source": "",
      "utm_term": ""
    }
  }
}

On this page