Dave Cross: Still Munging Data With Perl: Online event - Mar 17 Learn more

JDEGUEST / Net-API-Stripe-v1.0.4 / lib / Net / API / Stripe / Billing / UsageRecord.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
—
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

              
##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/Billing/UsageRecord.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
## Created 2019/11/02
## Modified 2020/05/15
## 
##----------------------------------------------------------------------------
## https://stripe.com/docs/api/usage_records
package Net::API::Stripe::Billing::UsageRecord;
BEGIN
{
    use strict;
    use parent qw( Net::API::Stripe::Generic );
    our( $VERSION ) = 'v0.100.0';
};
sub id { shift->_set_get_scalar( 'id', @_ ); }
sub object { shift->_set_get_scalar( 'object', @_ ); }
sub livemode { shift->_set_get_boolean( 'livemode', @_ ); }
sub quantity { shift->_set_get_number( 'quantity', @_ ); }
sub subscription_item { shift->_set_get_scalar( 'subscription_item', @_ ); }
sub timestamp { shift->_set_get_datetime( 'timestamp', @_ ); }
1;
__END__
=encoding utf8
=head1 NAME
Net::API::Stripe::Billing::UsageRecord - A Stripe Usage Record Object
=head1 SYNOPSIS
    my $usage_record = $stripe->usage_record({
        quantity => 1,
        subscription_item => $subscription_item_object,
        # Can be a unix timestamp or an iso 8601 date
        timestamp => '2020-04-01',
    });
=head1 VERSION
    v0.100.0
=head1 DESCRIPTION
Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription plans.
=head1 CONSTRUCTOR
=over 4
=item B<new>( %ARG )
Creates a new L<Net::API::Stripe::Billing::UsageRecord> object.
It may also take an hash like arguments, that also are method of the same name.
=back
=head1 METHODS
=over 4
=item B<id> string
Unique identifier for the object.
=item B<object> string, value is "usage_record"
String representing the object’s type. Objects of the same type share the same value.
=item B<livemode> boolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
=item B<quantity> positive integer or zero
The usage quantity for the specified date.
=item B<subscription_item> string
The ID of the subscription item this usage record contains data for.
=item B<timestamp> timestamp
The timestamp when this usage occurred.
=back
=head1 API SAMPLE
        {
          "id": "mbur_fake123456789",
          "object": "usage_record",
          "livemode": false,
          "quantity": 100,
          "subscription_item": "si_fake123456789",
          "timestamp": 1571397911
        }
=head1 HISTORY
=head2 v0.1
Initial version
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 SEE ALSO
Stripe API documentation:
L<https://stripe.com/docs/api/usage_records>, L<https://stripe.com/docs/billing/subscriptions/metered-billing>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut