API Access to
* Reports.
*
* Note that reports can only be run based on your live-mode data (not test-mode
* data), and thus related requests must be made with a live-mode API key.
*
* @property string $id Unique identifier for the object.
* @property string $object String representing the object's type. Objects of the same type share the same value.
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
* @property null|string $error If something should go wrong during the run, a message about the failure (populated when status=failed
).
* @property bool $livemode Always true
: reports can only be run on live-mode data.
* @property \Stripe\StripeObject $parameters
* @property string $report_type The ID of the report type to run, such as "balance.summary.1"
.
* @property null|\Stripe\File $result The file object representing the result of the report run (populated when status=succeeded
).
* @property string $status Status of this report run. This will be pending
when the run is initially created. When the run finishes, this will be set to succeeded
and the result
field will be populated. Rarely, we may encounter an error, at which point this will be set to failed
and the error
field will be populated.
* @property null|int $succeeded_at Timestamp at which this run successfully finished (populated when status=succeeded
). Measured in seconds since the Unix epoch.
*/
class ReportRun extends \Stripe\ApiResource
{
const OBJECT_NAME = 'reporting.report_run';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
}